diff --git a/docs/api/_category_.yml b/docs/api/_category_.yml new file mode 100644 index 000000000..24a460261 --- /dev/null +++ b/docs/api/_category_.yml @@ -0,0 +1 @@ +label: "API" \ No newline at end of file diff --git a/docs/api/classes/Context.md b/docs/api/classes/Context.md new file mode 100644 index 000000000..fa512b004 --- /dev/null +++ b/docs/api/classes/Context.md @@ -0,0 +1,243 @@ +--- +id: "Context" +title: "Class: Context" +sidebar_label: "Context" +sidebar_position: 0 +custom_edit_url: null +--- + +Provides values shared between +Message and ChatInputCommandInteraction + +## Constructors + +### constructor + +• `Private` **new Context**(`oMsg?`, `oInterac?`) + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `oMsg` | `Option`<`Message`<`boolean`\>\> | `None` | +| `oInterac` | `Option`<`ChatInputCommandInteraction`<`CacheType`\>\> | `None` | + +#### Defined in + +[src/handler/structures/context.ts:31](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L31) + +## Accessors + +### channel + +• `get` **channel**(): [`Nullish`](../modules.md#nullish)<`TextBasedChannel`\> + +#### Returns + +[`Nullish`](../modules.md#nullish)<`TextBasedChannel`\> + +#### Defined in + +[src/handler/structures/context.ts:63](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L63) + +___ + +### client + +• `get` **client**(): `Client`<`boolean`\> + +#### Returns + +`Client`<`boolean`\> + +#### Defined in + +[src/handler/structures/context.ts:108](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L108) + +___ + +### createdTimestamp + +• `get` **createdTimestamp**(): `number` + +#### Returns + +`number` + +#### Defined in + +[src/handler/structures/context.ts:77](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L77) + +___ + +### guild + +• `get` **guild**(): `Guild` + +#### Returns + +`Guild` + +#### Defined in + +[src/handler/structures/context.ts:84](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L84) + +___ + +### guildId + +• `get` **guildId**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/handler/structures/context.ts:91](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L91) + +___ + +### id + +• `get` **id**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/handler/structures/context.ts:56](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L56) + +___ + +### inGuild + +• `get` **inGuild**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[src/handler/structures/context.ts:115](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L115) + +___ + +### interaction + +• `get` **interaction**(): `ChatInputCommandInteraction`<`CacheType`\> + +Getting the ChatInputCommandInteraction object. Crashes if module type is +CommandType.Text or the event fired in a Both command was +Message + +#### Returns + +`ChatInputCommandInteraction`<`CacheType`\> + +#### Defined in + +[src/handler/structures/context.ts:52](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L52) + +___ + +### member + +• `get` **member**(): [`Nullish`](../modules.md#nullish)<`GuildMember` \| `APIGuildMember`\> + +#### Returns + +[`Nullish`](../modules.md#nullish)<`GuildMember` \| `APIGuildMember`\> + +#### Defined in + +[src/handler/structures/context.ts:101](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L101) + +___ + +### message + +• `get` **message**(): `Message`<`boolean`\> + +Getting the Message object. Crashes if module type is +CommandType.Slash or the event fired in a Both command was +ChatInputCommandInteraction + +#### Returns + +`Message`<`boolean`\> + +#### Defined in + +[src/handler/structures/context.ts:44](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L44) + +___ + +### user + +• `get` **user**(): `User` + +#### Returns + +`User` + +#### Defined in + +[src/handler/structures/context.ts:70](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L70) + +## Methods + +### isEmpty + +▸ **isEmpty**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[src/handler/structures/context.ts:129](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L129) + +___ + +### reply + +▸ **reply**(`content`): `Promise`<`Message`<`boolean`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `content` | `string` \| `Omit`<`InteractionReplyOptions`, ``"fetchReply"``\> \| `ReplyMessageOptions` | + +#### Returns + +`Promise`<`Message`<`boolean`\>\> + +#### Defined in + +[src/handler/structures/context.ts:133](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L133) + +___ + +### wrap + +▸ `Static` **wrap**(`wrappable`): [`Context`](Context.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `wrappable` | `Message`<`boolean`\> \| `ChatInputCommandInteraction`<`CacheType`\> | + +#### Returns + +[`Context`](Context.md) + +#### Defined in + +[src/handler/structures/context.ts:122](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/context.ts#L122) diff --git a/docs/api/classes/SernEmitter.md b/docs/api/classes/SernEmitter.md new file mode 100644 index 000000000..e1afd0d27 --- /dev/null +++ b/docs/api/classes/SernEmitter.md @@ -0,0 +1,1116 @@ +--- +id: "SernEmitter" +title: "Class: SernEmitter" +sidebar_label: "SernEmitter" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- `EventEmitter` + + ↳ **`SernEmitter`** + +## Constructors + +### constructor + +• **new SernEmitter**(`options?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | `EventEmitterOptions` | + +#### Inherited from + +EventEmitter.constructor + +#### Defined in + +node_modules/@types/node/events.d.ts:74 + +## Properties + +### captureRejectionSymbol + +▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](SernEmitter.md#capturerejectionsymbol) + +#### Inherited from + +EventEmitter.captureRejectionSymbol + +#### Defined in + +node_modules/@types/node/events.d.ts:291 + +___ + +### captureRejections + +▪ `Static` **captureRejections**: `boolean` + +Sets or gets the default captureRejection value for all emitters. + +#### Inherited from + +EventEmitter.captureRejections + +#### Defined in + +node_modules/@types/node/events.d.ts:296 + +___ + +### defaultMaxListeners + +▪ `Static` **defaultMaxListeners**: `number` + +#### Inherited from + +EventEmitter.defaultMaxListeners + +#### Defined in + +node_modules/@types/node/events.d.ts:297 + +___ + +### errorMonitor + +▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](SernEmitter.md#errormonitor) + +This symbol shall be used to install a listener for only monitoring `'error'` +events. Listeners installed using this symbol are called before the regular +`'error'` listeners are called. + +Installing a listener using this symbol does not change the behavior once an +`'error'` event is emitted, therefore the process will still crash if no +regular `'error'` listener is installed. + +#### Inherited from + +EventEmitter.errorMonitor + +#### Defined in + +node_modules/@types/node/events.d.ts:290 + +## Methods + +### addListener + +▸ **addListener**(`eventName`, `listener`): [`SernEmitter`](SernEmitter.md) + +Alias for `emitter.on(eventName, listener)`. + +**`Since`** + +v0.1.26 + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`SernEmitter`](SernEmitter.md) + +#### Inherited from + +EventEmitter.addListener + +#### Defined in + +node_modules/@types/node/events.d.ts:317 + +___ + +### emit + +▸ **emit**<`T`\>(`eventName`, ...`args`): `boolean` + +Listening to sern events with on. This event stays on until a crash or a normal exit + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends keyof [`SernEventsMapping`](../modules.md#serneventsmapping) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `T` | | +| `...args` | [`SernEventsMapping`](../modules.md#serneventsmapping)[`T`] | the arguments for emitting the { eventName } | + +#### Returns + +`boolean` + +#### Overrides + +EventEmitter.emit + +#### Defined in + +[src/handler/sernEmitter.ts:32](https://github.com/sern-handler/handler/blob/2009593/src/handler/sernEmitter.ts#L32) + +___ + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +const EventEmitter = require('events'); +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +**`Since`** + +v6.0.0 + +#### Returns + +(`string` \| `symbol`)[] + +#### Inherited from + +EventEmitter.eventNames + +#### Defined in + +node_modules/@types/node/events.d.ts:632 + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](SernEmitter.md#defaultmaxlisteners). + +**`Since`** + +v1.0.0 + +#### Returns + +`number` + +#### Inherited from + +EventEmitter.getMaxListeners + +#### Defined in + +node_modules/@types/node/events.d.ts:489 + +___ + +### listenerCount + +▸ **listenerCount**(`eventName`): `number` + +Returns the number of listeners listening to the event named `eventName`. + +**`Since`** + +v3.2.0 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event being listened for | + +#### Returns + +`number` + +#### Inherited from + +EventEmitter.listenerCount + +#### Defined in + +node_modules/@types/node/events.d.ts:579 + +___ + +### listeners + +▸ **listeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +**`Since`** + +v0.1.26 + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Inherited from + +EventEmitter.listeners + +#### Defined in + +node_modules/@types/node/events.d.ts:502 + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`SernEmitter`](SernEmitter.md) + +Alias for `emitter.removeListener()`. + +**`Since`** + +v10.0.0 + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`SernEmitter`](SernEmitter.md) + +#### Inherited from + +EventEmitter.off + +#### Defined in + +node_modules/@types/node/events.d.ts:462 + +___ + +### on + +▸ **on**<`T`\>(`eventName`, `listener`): [`SernEmitter`](SernEmitter.md) + +Listening to sern events with on. This event stays on until a crash or a normal exit + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends keyof [`SernEventsMapping`](../modules.md#serneventsmapping) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `T` | | +| `listener` | (...`args`: [`SernEventsMapping`](../modules.md#serneventsmapping)[`T`][]) => `void` | what to do with the data | + +#### Returns + +[`SernEmitter`](SernEmitter.md) + +#### Overrides + +EventEmitter.on + +#### Defined in + +[src/handler/sernEmitter.ts:10](https://github.com/sern-handler/handler/blob/2009593/src/handler/sernEmitter.ts#L10) + +___ + +### once + +▸ **once**<`T`\>(`eventName`, `listener`): [`SernEmitter`](SernEmitter.md) + +Listening to sern events with on. This event stays on until a crash or a normal exit + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends keyof [`SernEventsMapping`](../modules.md#serneventsmapping) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `T` | | +| `listener` | (...`args`: [`SernEventsMapping`](../modules.md#serneventsmapping)[`T`][]) => `void` | what to do with the data | + +#### Returns + +[`SernEmitter`](SernEmitter.md) + +#### Overrides + +EventEmitter.once + +#### Defined in + +[src/handler/sernEmitter.ts:21](https://github.com/sern-handler/handler/blob/2009593/src/handler/sernEmitter.ts#L21) + +___ + +### prependListener + +▸ **prependListener**(`eventName`, `listener`): [`SernEmitter`](SernEmitter.md) + +Adds the `listener` function to the _beginning_ of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.prependListener('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +**`Since`** + +v6.0.0 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`SernEmitter`](SernEmitter.md) + +#### Inherited from + +EventEmitter.prependListener + +#### Defined in + +node_modules/@types/node/events.d.ts:597 + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`eventName`, `listener`): [`SernEmitter`](SernEmitter.md) + +Adds a **one-time**`listener` function for the event named `eventName` to the_beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +**`Since`** + +v6.0.0 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`SernEmitter`](SernEmitter.md) + +#### Inherited from + +EventEmitter.prependOnceListener + +#### Defined in + +node_modules/@types/node/events.d.ts:613 + +___ + +### rawListeners + +▸ **rawListeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +**`Since`** + +v9.4.0 + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Inherited from + +EventEmitter.rawListeners + +#### Defined in + +node_modules/@types/node/events.d.ts:532 + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`SernEmitter`](SernEmitter.md) + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +**`Since`** + +v0.1.26 + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `string` \| `symbol` | + +#### Returns + +[`SernEmitter`](SernEmitter.md) + +#### Inherited from + +EventEmitter.removeAllListeners + +#### Defined in + +node_modules/@types/node/events.d.ts:473 + +___ + +### removeListener + +▸ **removeListener**(`eventName`, `listener`): [`SernEmitter`](SernEmitter.md) + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and_before_ the last listener finishes execution will +not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +**`Since`** + +v0.1.26 + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`SernEmitter`](SernEmitter.md) + +#### Inherited from + +EventEmitter.removeListener + +#### Defined in + +node_modules/@types/node/events.d.ts:457 + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`SernEmitter`](SernEmitter.md) + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +**`Since`** + +v0.3.5 + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +[`SernEmitter`](SernEmitter.md) + +#### Inherited from + +EventEmitter.setMaxListeners + +#### Defined in + +node_modules/@types/node/events.d.ts:483 + +___ + +### getEventListeners + +▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +For `EventEmitter`s this behaves exactly the same as calling `.listeners` on +the emitter. + +For `EventTarget`s this is the only way to get the event listeners for the +event target. This is useful for debugging and diagnostic purposes. + +```js +const { getEventListeners, EventEmitter } = require('events'); + +{ + const ee = new EventEmitter(); + const listener = () => console.log('Events are fun'); + ee.on('foo', listener); + getEventListeners(ee, 'foo'); // [listener] +} +{ + const et = new EventTarget(); + const listener = () => console.log('Events are fun'); + et.addEventListener('foo', listener); + getEventListeners(et, 'foo'); // [listener] +} +``` + +**`Since`** + +v15.2.0, v14.17.0 + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | `EventEmitter` \| `DOMEventTarget` | +| `name` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Inherited from + +EventEmitter.getEventListeners + +#### Defined in + +node_modules/@types/node/events.d.ts:262 + +___ + +### listenerCount + +▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` + +A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. + +```js +const { EventEmitter, listenerCount } = require('events'); +const myEmitter = new EventEmitter(); +myEmitter.on('event', () => {}); +myEmitter.on('event', () => {}); +console.log(listenerCount(myEmitter, 'event')); +// Prints: 2 +``` + +**`Since`** + +v0.9.12 + +**`Deprecated`** + +Since v3.2.0 - Use `listenerCount` instead. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | `EventEmitter` | The emitter to query | +| `eventName` | `string` \| `symbol` | The event name | + +#### Returns + +`number` + +#### Inherited from + +EventEmitter.listenerCount + +#### Defined in + +node_modules/@types/node/events.d.ts:234 + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): `AsyncIterableIterator`<`any`\> + +```js +const { on, EventEmitter } = require('events'); + +(async () => { + const ee = new EventEmitter(); + + // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + }); + + for await (const event of on(ee, 'foo')) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here +})(); +``` + +Returns an `AsyncIterator` that iterates `eventName` events. It will throw +if the `EventEmitter` emits `'error'`. It removes all listeners when +exiting the loop. The `value` returned by each iteration is an array +composed of the emitted event arguments. + +An `AbortSignal` can be used to cancel waiting on events: + +```js +const { on, EventEmitter } = require('events'); +const ac = new AbortController(); + +(async () => { + const ee = new EventEmitter(); + + // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + }); + + for await (const event of on(ee, 'foo', { signal: ac.signal })) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here +})(); + +process.nextTick(() => ac.abort()); +``` + +**`Since`** + +v13.6.0, v12.16.0 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | `EventEmitter` | - | +| `eventName` | `string` | The name of the event being listened for | +| `options?` | `StaticEventEmitterOptions` | - | + +#### Returns + +`AsyncIterableIterator`<`any`\> + +that iterates `eventName` events emitted by the `emitter` + +#### Inherited from + +EventEmitter.on + +#### Defined in + +node_modules/@types/node/events.d.ts:217 + +▸ `Static` **on**<`K`\>(`eventEmitter`, `eventName`): `AsyncIterator`<`ClientEvents`[`K`], `any`, `undefined`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends keyof `ClientEvents` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventEmitter` | `Client`<`boolean`\> | +| `eventName` | `K` | + +#### Returns + +`AsyncIterator`<`ClientEvents`[`K`], `any`, `undefined`\> + +#### Inherited from + +EventEmitter.on + +#### Defined in + +node_modules/discord.js/typings/index.d.ts:195 + +___ + +### once + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given +event or that is rejected if the `EventEmitter` emits `'error'` while waiting. +The `Promise` will resolve with an array of all the arguments emitted to the +given event. + +This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event +semantics and does not listen to the `'error'` event. + +```js +const { once, EventEmitter } = require('events'); + +async function run() { + const ee = new EventEmitter(); + + process.nextTick(() => { + ee.emit('myevent', 42); + }); + + const [value] = await once(ee, 'myevent'); + console.log(value); + + const err = new Error('kaboom'); + process.nextTick(() => { + ee.emit('error', err); + }); + + try { + await once(ee, 'myevent'); + } catch (err) { + console.log('error happened', err); + } +} + +run(); +``` + +The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the +'`error'` event itself, then it is treated as any other kind of event without +special handling: + +```js +const { EventEmitter, once } = require('events'); + +const ee = new EventEmitter(); + +once(ee, 'error') + .then(([err]) => console.log('ok', err.message)) + .catch((err) => console.log('error', err.message)); + +ee.emit('error', new Error('boom')); + +// Prints: ok boom +``` + +An `AbortSignal` can be used to cancel waiting for the event: + +```js +const { EventEmitter, once } = require('events'); + +const ee = new EventEmitter(); +const ac = new AbortController(); + +async function foo(emitter, event, signal) { + try { + await once(emitter, event, { signal }); + console.log('event emitted!'); + } catch (error) { + if (error.name === 'AbortError') { + console.error('Waiting for the event was canceled!'); + } else { + console.error('There was an error', error.message); + } + } +} + +foo(ee, 'foo', ac.signal); +ac.abort(); // Abort waiting for the event +ee.emit('foo'); // Prints: Waiting for the event was canceled! +``` + +**`Since`** + +v11.13.0, v10.16.0 + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | `NodeEventTarget` | +| `eventName` | `string` \| `symbol` | +| `options?` | `StaticEventEmitterOptions` | + +#### Returns + +`Promise`<`any`[]\> + +#### Inherited from + +EventEmitter.once + +#### Defined in + +node_modules/@types/node/events.d.ts:157 + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | `DOMEventTarget` | +| `eventName` | `string` | +| `options?` | `StaticEventEmitterOptions` | + +#### Returns + +`Promise`<`any`[]\> + +#### Inherited from + +EventEmitter.once + +#### Defined in + +node_modules/@types/node/events.d.ts:158 + +▸ `Static` **once**<`K`\>(`eventEmitter`, `eventName`): `Promise`<`ClientEvents`[`K`]\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends keyof `ClientEvents` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventEmitter` | `Client`<`boolean`\> | +| `eventName` | `K` | + +#### Returns + +`Promise`<`ClientEvents`[`K`]\> + +#### Inherited from + +EventEmitter.once + +#### Defined in + +node_modules/discord.js/typings/index.d.ts:194 + +___ + +### setMaxListeners + +▸ `Static` **setMaxListeners**(`n?`, ...`eventTargets`): `void` + +```js +const { + setMaxListeners, + EventEmitter +} = require('events'); + +const target = new EventTarget(); +const emitter = new EventEmitter(); + +setMaxListeners(5, target, emitter); +``` + +**`Since`** + +v15.4.0 + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. | +| `...eventTargets` | (`EventEmitter` \| `DOMEventTarget`)[] | - | + +#### Returns + +`void` + +#### Inherited from + +EventEmitter.setMaxListeners + +#### Defined in + +node_modules/@types/node/events.d.ts:280 diff --git a/docs/api/classes/_category_.yml b/docs/api/classes/_category_.yml new file mode 100644 index 000000000..55c7980a4 --- /dev/null +++ b/docs/api/classes/_category_.yml @@ -0,0 +1,2 @@ +label: "Classes" +position: 3 \ No newline at end of file diff --git a/docs/api/enums/CommandType.md b/docs/api/enums/CommandType.md new file mode 100644 index 000000000..ca2a1c8d7 --- /dev/null +++ b/docs/api/enums/CommandType.md @@ -0,0 +1,116 @@ +--- +id: "CommandType" +title: "Enumeration: CommandType" +sidebar_label: "CommandType" +sidebar_position: 0 +custom_edit_url: null +--- + +**`Example`** + +```ts +export default commandModule({ + // highlight-next-line + type : CommandType.Text, + name : 'a text command' + execute(message) { + console.log(message.content) + } +}) +``` + +## Enumeration Members + +### Both + +• **Both** = ``3`` + +The CommandType for hybrid commands, text and slash + +#### Defined in + +[src/handler/structures/enums.ts:27](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L27) + +___ + +### Button + +• **Button** = ``16`` + +The CommandType for ButtonInteraction commands + +#### Defined in + +[src/handler/structures/enums.ts:39](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L39) + +___ + +### MenuMsg + +• **MenuMsg** = ``8`` + +The CommandType for MessageContextMenuInteraction commands + +#### Defined in + +[src/handler/structures/enums.ts:35](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L35) + +___ + +### MenuSelect + +• **MenuSelect** = ``32`` + +The CommandType for SelectMenuInteraction commands + +#### Defined in + +[src/handler/structures/enums.ts:43](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L43) + +___ + +### MenuUser + +• **MenuUser** = ``4`` + +The CommandType for UserContextMenuInteraction commands + +#### Defined in + +[src/handler/structures/enums.ts:31](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L31) + +___ + +### Modal + +• **Modal** = ``64`` + +The CommandType for ModalSubmitInteraction commands + +#### Defined in + +[src/handler/structures/enums.ts:47](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L47) + +___ + +### Slash + +• **Slash** = ``2`` + +The CommandType for slash commands + +#### Defined in + +[src/handler/structures/enums.ts:23](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L23) + +___ + +### Text + +• **Text** = ``1`` + +The CommandType for text commands + +#### Defined in + +[src/handler/structures/enums.ts:19](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L19) diff --git a/docs/api/enums/EventType.md b/docs/api/enums/EventType.md new file mode 100644 index 000000000..bdd27b006 --- /dev/null +++ b/docs/api/enums/EventType.md @@ -0,0 +1,57 @@ +--- +id: "EventType" +title: "Enumeration: EventType" +sidebar_label: "EventType" +sidebar_position: 0 +custom_edit_url: null +--- + +**`Example`** + +```ts +export default eventModule({ + //highlight-next-line + type : EventType.Discord, + name : 'guildMemberAdd' + execute(member : GuildMember) { + console.log(member) + } +}) +``` + +## Enumeration Members + +### Discord + +• **Discord** = ``1`` + +The EventType for handling discord events + +#### Defined in + +[src/handler/structures/enums.ts:68](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L68) + +___ + +### External + +• **External** = ``3`` + +The EventType for handling external events. +Could be for example, `process` events, database events + +#### Defined in + +[src/handler/structures/enums.ts:77](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L77) + +___ + +### Sern + +• **Sern** = ``2`` + +The EventType for handling sern events + +#### Defined in + +[src/handler/structures/enums.ts:72](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L72) diff --git a/docs/api/enums/PayloadType.md b/docs/api/enums/PayloadType.md new file mode 100644 index 000000000..5767d5ffc --- /dev/null +++ b/docs/api/enums/PayloadType.md @@ -0,0 +1,43 @@ +--- +id: "PayloadType" +title: "Enumeration: PayloadType" +sidebar_label: "PayloadType" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### Failure + +• **Failure** = ``"failure"`` + +The PayloadType for a SernEmitter failure event + +#### Defined in + +[src/handler/structures/enums.ts:114](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L114) + +___ + +### Success + +• **Success** = ``"success"`` + +The PayloadType for a SernEmitter success event + +#### Defined in + +[src/handler/structures/enums.ts:110](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L110) + +___ + +### Warning + +• **Warning** = ``"warning"`` + +The PayloadType for a SernEmitter warning event + +#### Defined in + +[src/handler/structures/enums.ts:118](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L118) diff --git a/docs/api/enums/PluginType.md b/docs/api/enums/PluginType.md new file mode 100644 index 000000000..0e6a6cb2c --- /dev/null +++ b/docs/api/enums/PluginType.md @@ -0,0 +1,43 @@ +--- +id: "PluginType" +title: "Enumeration: PluginType" +sidebar_label: "PluginType" +sidebar_position: 0 +custom_edit_url: null +--- + +**`Example`** + +```ts +export default function myPlugin() : EventPlugin { + //highlight-next-line + type : PluginType.Event, + execute([ctx, args], controller) { + return controller.next(); + } +} +``` + +## Enumeration Members + +### Command + +• **Command** = ``1`` + +The PluginType for CommandPlugins + +#### Defined in + +[src/handler/structures/enums.ts:97](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L97) + +___ + +### Event + +• **Event** = ``2`` + +The PluginType for EventPlugins + +#### Defined in + +[src/handler/structures/enums.ts:101](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/enums.ts#L101) diff --git a/docs/api/enums/_category_.yml b/docs/api/enums/_category_.yml new file mode 100644 index 000000000..1687a9e03 --- /dev/null +++ b/docs/api/enums/_category_.yml @@ -0,0 +1,2 @@ +label: "Enumerations" +position: 2 \ No newline at end of file diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 000000000..f3632616a --- /dev/null +++ b/docs/api/index.md @@ -0,0 +1,90 @@ +--- +id: "index" +title: "@sern/handler" +sidebar_label: "Readme" +sidebar_position: 0 +custom_edit_url: null +--- + +# SernHandler + +NPM version +NPM downloads +[![License: MIT](https://img.shields.io/badge/License-MIT-blavk.svg)](https://opensource.org/licenses/MIT) + +A customizable, batteries-included, powerful discord.js framework to automate and streamline your bot development. + +## Installation + +```sh +npm install @sern/handler +``` + +```sh +yarn add @sern/handler +``` + +```sh +pnpm add @sern/handler +``` + +## Basic Usage + +#### ` index.js (CommonJS)` + +```js +const { Client, GatewayIntentBits } = require('discord.js'); +const { Sern } = require('@sern/handler'); +const { defaultPrefix, token } = require('./config.json'); + +const client = new Client({ + intents: [ + GatewayIntentBits.Guilds, + GatewayIntentBits.GuildMembers, + GatewayIntentBits.GuildMessages + ] +}); + +Sern.init({ + client, + defaultPrefix, + commands : 'src/commands', +}); + +client.login(token); +``` + +#### ` ping.js (CommonJS)` + +```js +const { Sern, CommandType } = require('@sern/handler'); + +exports.default = { + description: 'A ping pong command', + type: CommandType.Slash, + execute(ctx) { + ctx.reply('pong!'); + } + }; +``` + +See our [templates](https://github.com/sern-handler/templates) for TypeScript examples and more + +## CLI + +It is **highly encouraged** to use the [command line interface](https://github.com/sern-handler/cli) for your project. Don't forget to view it. + +## Links + +- [Official Documentation](https://sern-handler.js.org) +- [Support Server](https://discord.com/invite/mmyCTnYtbF) + +## Contribute + +- Read our contribution [guidelines](https://github.com/sern-handler/handler) carefully +- Pull up on [issues](https://github.com/sern-handler/handler/issues) and report bugs +- All kinds of contributions are welcomed. + +## Roadmap + +You can check our [roadmap](https://github.com/sern-handler/roadmap) to see what's going to be added or patched in the future. diff --git a/docs/api/interfaces/Controller.md b/docs/api/interfaces/Controller.md new file mode 100644 index 000000000..751b1e730 --- /dev/null +++ b/docs/api/interfaces/Controller.md @@ -0,0 +1,43 @@ +--- +id: "Controller" +title: "Interface: Controller" +sidebar_label: "Controller" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### next + +• **next**: () => `Ok`<`void`\> + +#### Type declaration + +▸ (): `Ok`<`void`\> + +##### Returns + +`Ok`<`void`\> + +#### Defined in + +[src/handler/plugins/plugin.ts:29](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L29) + +___ + +### stop + +• **stop**: () => `Err`<`void`\> + +#### Type declaration + +▸ (): `Err`<`void`\> + +##### Returns + +`Err`<`void`\> + +#### Defined in + +[src/handler/plugins/plugin.ts:30](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L30) diff --git a/docs/api/interfaces/Wrapper.md b/docs/api/interfaces/Wrapper.md new file mode 100644 index 000000000..b30da2bb7 --- /dev/null +++ b/docs/api/interfaces/Wrapper.md @@ -0,0 +1,59 @@ +--- +id: "Wrapper" +title: "Interface: Wrapper" +sidebar_label: "Wrapper" +sidebar_position: 0 +custom_edit_url: null +--- + +An object to be passed into Sern#init() function. + +## Properties + +### client + +• `Readonly` **client**: `Client`<`boolean`\> + +#### Defined in + +[src/handler/structures/wrapper.ts:10](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/wrapper.ts#L10) + +___ + +### commands + +• `Readonly` **commands**: `string` + +#### Defined in + +[src/handler/structures/wrapper.ts:13](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/wrapper.ts#L13) + +___ + +### defaultPrefix + +• `Optional` `Readonly` **defaultPrefix**: `string` + +#### Defined in + +[src/handler/structures/wrapper.ts:12](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/wrapper.ts#L12) + +___ + +### events + +• `Optional` `Readonly` **events**: `string` \| { `absPath`: `string` ; `mod`: `EventModule` }[] \| () => { `absPath`: `string` ; `mod`: `EventModule` }[] + +#### Defined in + +[src/handler/structures/wrapper.ts:14](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/wrapper.ts#L14) + +___ + +### sernEmitter + +• `Optional` `Readonly` **sernEmitter**: [`SernEmitter`](../classes/SernEmitter.md) + +#### Defined in + +[src/handler/structures/wrapper.ts:11](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/wrapper.ts#L11) diff --git a/docs/api/interfaces/_category_.yml b/docs/api/interfaces/_category_.yml new file mode 100644 index 000000000..43bec88cf --- /dev/null +++ b/docs/api/interfaces/_category_.yml @@ -0,0 +1,2 @@ +label: "Interfaces" +position: 4 \ No newline at end of file diff --git a/docs/api/modules.md b/docs/api/modules.md new file mode 100644 index 000000000..132f88281 --- /dev/null +++ b/docs/api/modules.md @@ -0,0 +1,627 @@ +--- +id: "modules" +title: "@sern/handler" +sidebar_label: "Exports" +sidebar_position: 0.5 +custom_edit_url: null +--- + +## Namespaces + +- [Sern](namespaces/Sern.md) + +## Enumerations + +- [CommandType](enums/CommandType.md) +- [EventType](enums/EventType.md) +- [PayloadType](enums/PayloadType.md) +- [PluginType](enums/PluginType.md) + +## Classes + +- [Context](classes/Context.md) +- [SernEmitter](classes/SernEmitter.md) + +## Interfaces + +- [Controller](interfaces/Controller.md) +- [Wrapper](interfaces/Wrapper.md) + +## Type Aliases + +### Args + +Ƭ **Args**: [`ParseType`](modules.md#parsetype)<{ `slash`: [`SlashOptions`](modules.md#slashoptions) ; `text`: `string`[] }\> + +#### Defined in + +[src/types/handler.ts:11](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L11) + +___ + +### AutocompletePlugin + +Ƭ **AutocompletePlugin**: [`Override`](modules.md#override)<`BaseModule`, { `execute`: (`autocmp`: `AutocompleteInteraction`, `controlller`: [`Controller`](interfaces/Controller.md)) => `Awaitable`<`Result`<`void`, `void`\>\> ; `type`: [`Event`](enums/PluginType.md#event) }\> + +#### Defined in + +[src/handler/plugins/plugin.ts:92](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L92) + +___ + +### BaseOptions + +Ƭ **BaseOptions**: `ApplicationCommandChoicesData` \| `ApplicationCommandNonOptionsData` \| `ApplicationCommandChannelOptionData` \| `ApplicationCommandNumericOptionData` \| `ApplicationCommandAttachmentOption` \| [`SernAutocompleteData`](modules.md#sernautocompletedata) + +Type that replaces autocomplete with [SernAutocompleteData](modules.md#sernautocompletedata) + +#### Defined in + +[src/handler/structures/module.ts:181](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L181) + +___ + +### BothCommand + +Ƭ **BothCommand**: [`Override`](modules.md#override)<`BaseModule`, { `alias?`: `string`[] ; `execute`: (`ctx`: [`Context`](classes/Context.md), `args`: [`Args`](modules.md#args)) => `Awaitable`<`void` \| `unknown`\> ; `onEvent`: [`EventPlugin`](modules.md#eventplugin)<[`Both`](enums/CommandType.md#both)\>[] ; `options?`: [`SernOptionsData`](modules.md#sernoptionsdata)[] ; `plugins`: [`CommandPlugin`](modules.md#commandplugin)[] ; `type`: [`Both`](enums/CommandType.md#both) }\> + +#### Defined in + +[src/handler/structures/module.ts:55](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L55) + +___ + +### CommandModuleNoPlugins + +Ƭ **CommandModuleNoPlugins**: { [T in CommandType]: Omit } + +#### Defined in + +[src/handler/plugins/plugin.ts:145](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L145) + +___ + +### CommandModulePlugin + +Ƭ **CommandModulePlugin**<`T`\>: [`EventPlugin`](modules.md#eventplugin)<`T`\> \| [`CommandPlugin`](modules.md#commandplugin)<`T`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`CommandType`](enums/CommandType.md) | + +#### Defined in + +[src/handler/plugins/plugin.ts:173](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L173) + +___ + +### CommandPlugin + +Ƭ **CommandPlugin**<`T`\>: { [K in T]: Override }[`T`] + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends keyof `CommandModuleDefs` = keyof `CommandModuleDefs` | + +#### Defined in + +[src/handler/plugins/plugin.ts:40](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L40) + +___ + +### DefinedCommandModule + +Ƭ **DefinedCommandModule**: [`DefinitelyDefined`](modules.md#definitelydefined)<`CommandModule`, ``"name"`` \| ``"description"``\> + +#### Defined in + +[src/types/handler.ts:48](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L48) + +___ + +### DefinedEventModule + +Ƭ **DefinedEventModule**: [`DefinitelyDefined`](modules.md#definitelydefined)<`EventModule`, ``"name"`` \| ``"description"``\> + +#### Defined in + +[src/types/handler.ts:49](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L49) + +___ + +### DefinedModule + +Ƭ **DefinedModule**: [`DefinitelyDefined`](modules.md#definitelydefined)<[`Module`](modules.md#module), ``"name"`` \| ``"description"``\> + +After modules are transformed, name and description are given default values if none +are provided to Module. This type represents that transformation + +#### Defined in + +[src/types/handler.ts:47](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L47) + +___ + +### DefinitelyDefined + +Ƭ **DefinitelyDefined**<`T`, `K`\>: { [L in K]-?: T[L] extends Record ? DefinitelyDefined : Required[L] } & `T` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T` | +| `K` | extends keyof `T` = keyof `T` | + +#### Defined in + +[src/types/handler.ts:18](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L18) + +___ + +### DiscordEmitterPlugin + +Ƭ **DiscordEmitterPlugin**: [`Override`](modules.md#override)<`BasePlugin`, { `execute`: (`wrapper`: `Client`, `module`: [`DefinitelyDefined`](modules.md#definitelydefined)<`DiscordEventCommand`, ``"name"`` \| ``"description"``\>, `controller`: [`Controller`](interfaces/Controller.md)) => `Awaitable`<`Result`<`void`, `void`\>\> ; `type`: [`Command`](enums/PluginType.md#command) }\> + +#### Defined in + +[src/handler/plugins/plugin.ts:57](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L57) + +___ + +### DiscordEventPlugin + +Ƭ **DiscordEventPlugin**<`T`\>: [`Override`](modules.md#override)<`BasePlugin`, { `execute`: (`args`: `ClientEvents`[`T`], `controller`: [`Controller`](interfaces/Controller.md)) => `Awaitable`<`Result`<`void`, `void`\>\> ; `name?`: `T` ; `type`: [`Event`](enums/PluginType.md#event) }\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends keyof `ClientEvents` = keyof `ClientEvents` | + +#### Defined in + +[src/handler/plugins/plugin.ts:136](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L136) + +___ + +### EventInput + +Ƭ **EventInput**: `string` \| { `absPath`: `string` ; `mod`: `EventModule` }[] \| () => { `absPath`: `string` ; `mod`: `EventModule` }[] + +#### Defined in + +[src/types/handler.ts:24](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L24) + +___ + +### EventModuleCommandPluginDefs + +Ƭ **EventModuleCommandPluginDefs**: `Object` + +Event Module Command Plugins + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `1` | [`DiscordEmitterPlugin`](modules.md#discordemitterplugin) | +| `2` | [`SernEmitterPlugin`](modules.md#sernemitterplugin) | +| `3` | [`ExternalEmitterPlugin`](modules.md#externalemitterplugin) | + +#### Defined in + +[src/handler/plugins/plugin.ts:163](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L163) + +___ + +### EventModuleEventPluginDefs + +Ƭ **EventModuleEventPluginDefs**: `Object` + +Event Module Event Plugins + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `1` | [`DiscordEventPlugin`](modules.md#discordeventplugin) | +| `2` | [`SernEventPlugin`](modules.md#serneventplugin) | +| `3` | [`ExternalEventPlugin`](modules.md#externaleventplugin) | + +#### Defined in + +[src/handler/plugins/plugin.ts:154](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L154) + +___ + +### EventModulePlugin + +Ƭ **EventModulePlugin**<`T`\>: [`EventModuleEventPluginDefs`](modules.md#eventmoduleeventplugindefs)[`T`] \| [`EventModuleCommandPluginDefs`](modules.md#eventmodulecommandplugindefs)[`T`] + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`EventType`](enums/EventType.md) | + +#### Defined in + +[src/handler/plugins/plugin.ts:169](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L169) + +___ + +### EventModulesNoPlugins + +Ƭ **EventModulesNoPlugins**: { [T in EventType]: Omit } + +#### Defined in + +[src/handler/plugins/plugin.ts:148](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L148) + +___ + +### EventPlugin + +Ƭ **EventPlugin**<`T`\>: { [K in T]: Override }[`T`] + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends keyof `CommandModuleDefs` = keyof `CommandModuleDefs` | + +#### Defined in + +[src/handler/plugins/plugin.ts:103](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L103) + +___ + +### ExternalEmitterPlugin + +Ƭ **ExternalEmitterPlugin**<`T`\>: [`Override`](modules.md#override)<`BasePlugin`, { `execute`: (`wrapper`: `T`, `module`: [`DefinitelyDefined`](modules.md#definitelydefined)<`ExternalEventCommand`, ``"name"`` \| ``"description"``\>, `controller`: [`Controller`](interfaces/Controller.md)) => `Awaitable`<`Result`<`void`, `void`\>\> ; `type`: [`Command`](enums/PluginType.md#command) }\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `EventEmitter` = `EventEmitter` | + +#### Defined in + +[src/handler/plugins/plugin.ts:68](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L68) + +___ + +### ExternalEventPlugin + +Ƭ **ExternalEventPlugin**: [`Override`](modules.md#override)<`BasePlugin`, { `execute`: (`args`: `unknown`[], `controller`: [`Controller`](interfaces/Controller.md)) => `Awaitable`<`Result`<`void`, `void`\>\> ; `type`: [`Event`](enums/PluginType.md#event) }\> + +#### Defined in + +[src/handler/plugins/plugin.ts:128](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L128) + +___ + +### InputCommandModule + +Ƭ **InputCommandModule**: { [T in CommandType]: CommandModuleNoPlugins[T] & Object }[[`CommandType`](enums/CommandType.md)] + +User inputs this type. Sern processes behind the scenes for better usage + +#### Defined in + +[src/handler/plugins/plugin.ts:178](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L178) + +___ + +### InputEventModule + +Ƭ **InputEventModule**: { [T in EventType]: EventModulesNoPlugins[T] & Object }[[`EventType`](enums/EventType.md)] + +#### Defined in + +[src/handler/plugins/plugin.ts:182](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L182) + +___ + +### IsOptional + +Ƭ **IsOptional**<`T`\>: { [K in keyof T]-?: T[K] extends Required[K] ? false : true } + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[src/types/handler.ts:31](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L31) + +___ + +### Module + +Ƭ **Module**: `CommandModule` \| `EventModule` + +#### Defined in + +[src/handler/structures/module.ts:141](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L141) + +___ + +### Nullish + +Ƭ **Nullish**<`T`\>: `T` \| `undefined` \| ``null`` + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[src/types/handler.ts:4](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L4) + +___ + +### Override + +Ƭ **Override**<`T1`, `T2`\>: `Omit`<`T1`, keyof `T2`\> & `T2` + +#### Type parameters + +| Name | +| :------ | +| `T1` | +| `T2` | + +#### Defined in + +[src/types/handler.ts:16](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L16) + +___ + +### ParseType + +Ƭ **ParseType**<`T`\>: { [K in keyof T]: T[K] extends unknown ? [k: K, args: T[K]] : never }[keyof `T`] + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[src/types/handler.ts:7](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L7) + +___ + +### Payload + +Ƭ **Payload**: { `module`: [`Module`](modules.md#module) ; `type`: [`Success`](enums/PayloadType.md#success) } \| { `module`: [`Module`](modules.md#module) \| `undefined` ; `reason`: `string` \| `Error` ; `type`: [`Failure`](enums/PayloadType.md#failure) } + +#### Defined in + +[src/types/handler.ts:50](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L50) + +___ + +### Reconstruct + +Ƭ **Reconstruct**<`T`\>: `T` extends `Omit` ? `O` & [`Reconstruct`](modules.md#reconstruct)<`O`\> : `T` + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[src/types/handler.ts:29](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L29) + +___ + +### SernAutocompleteData + +Ƭ **SernAutocompleteData**: [`Override`](modules.md#override)<`BaseApplicationCommandOptionsData`, { `autocomplete`: ``true`` ; `command`: `AutocompleteCommand` ; `type`: `ApplicationCommandOptionType.String` \| `ApplicationCommandOptionType.Number` \| `ApplicationCommandOptionType.Integer` }\> + +#### Defined in + +[src/handler/structures/module.ts:166](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L166) + +___ + +### SernEmitterPlugin + +Ƭ **SernEmitterPlugin**: [`Override`](modules.md#override)<`BasePlugin`, { `execute`: (`wrapper`: [`SernEmitter`](classes/SernEmitter.md), `module`: [`DefinitelyDefined`](modules.md#definitelydefined)<`SernEventCommand`, ``"name"`` \| ``"description"``\>, `controller`: [`Controller`](interfaces/Controller.md)) => `Awaitable`<`Result`<`void`, `void`\>\> ; `type`: [`Command`](enums/PluginType.md#command) }\> + +#### Defined in + +[src/handler/plugins/plugin.ts:80](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L80) + +___ + +### SernEventPlugin + +Ƭ **SernEventPlugin**<`T`\>: [`Override`](modules.md#override)<`BasePlugin`, { `execute`: (`args`: [`SernEventsMapping`](modules.md#serneventsmapping)[`T`], `controller`: [`Controller`](interfaces/Controller.md)) => `Awaitable`<`Result`<`void`, `void`\>\> ; `name?`: `T` ; `type`: [`Event`](enums/PluginType.md#event) }\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends keyof [`SernEventsMapping`](modules.md#serneventsmapping) = keyof [`SernEventsMapping`](modules.md#serneventsmapping) | + +#### Defined in + +[src/handler/plugins/plugin.ts:116](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L116) + +___ + +### SernEventsMapping + +Ƭ **SernEventsMapping**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `error` | [`Error` \| `string`] | +| `module.activate` | [[`Payload`](modules.md#payload)] | +| `module.register` | [[`Payload`](modules.md#payload)] | +| `warning` | [`string`] | + +#### Defined in + +[src/types/handler.ts:53](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L53) + +___ + +### SernOptionsData + +Ƭ **SernOptionsData**<`U`\>: `U` extends `ApplicationCommandSubCommandData` ? [`SernSubCommandData`](modules.md#sernsubcommanddata) : `U` extends `ApplicationCommandSubGroupData` ? [`SernSubCommandGroupData`](modules.md#sernsubcommandgroupdata) : [`BaseOptions`](modules.md#baseoptions) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `U` | extends `ApplicationCommandOptionData` = `ApplicationCommandOptionData` | + +#### Defined in + +[src/handler/structures/module.ts:205](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L205) + +___ + +### SernSubCommandData + +Ƭ **SernSubCommandData**: [`Override`](modules.md#override)<`Omit`<`BaseApplicationCommandOptionsData`, ``"required"``\>, { `options?`: [`BaseOptions`](modules.md#baseoptions)[] ; `type`: `ApplicationCommandOptionType.Subcommand` }\> + +#### Defined in + +[src/handler/structures/module.ts:189](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L189) + +___ + +### SernSubCommandGroupData + +Ƭ **SernSubCommandGroupData**: [`Override`](modules.md#override)<`Omit`<`BaseApplicationCommandOptionsData`, ``"required"``\>, { `options?`: [`SernSubCommandData`](modules.md#sernsubcommanddata)[] ; `type`: `ApplicationCommandOptionType.SubcommandGroup` }\> + +#### Defined in + +[src/handler/structures/module.ts:197](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L197) + +___ + +### SlashCommand + +Ƭ **SlashCommand**: [`Override`](modules.md#override)<`BaseModule`, { `execute`: (`ctx`: [`Context`](classes/Context.md), `args`: [``"slash"``, [`SlashOptions`](modules.md#slashoptions)]) => `Awaitable`<`void` \| `unknown`\> ; `onEvent`: [`EventPlugin`](modules.md#eventplugin)<[`Slash`](enums/CommandType.md#slash)\>[] ; `options?`: [`SernOptionsData`](modules.md#sernoptionsdata)[] ; `plugins`: [`CommandPlugin`](modules.md#commandplugin)[] ; `type`: [`Slash`](enums/CommandType.md#slash) }\> + +#### Defined in + +[src/handler/structures/module.ts:44](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L44) + +___ + +### SlashOptions + +Ƭ **SlashOptions**: `Omit`<`CommandInteractionOptionResolver`, ``"getMessage"`` \| ``"getFocused"``\> + +#### Defined in + +[src/types/handler.ts:13](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L13) + +___ + +### SpreadParams + +Ƭ **SpreadParams**<`T`\>: (`args`: `Parameters`<`T`\>[`number`]) => `unknown` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends (...`args`: `never`) => `unknown` | + +#### Type declaration + +▸ (`args`): `unknown` + +Turns a function with a union of array of args into a single union + [ T , V , B ] | [ A ] => T | V | B | A + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `args` | `Parameters`<`T`\>[`number`] | + +##### Returns + +`unknown` + +#### Defined in + +[src/types/handler.ts:39](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L39) + +___ + +### TextCommand + +Ƭ **TextCommand**: [`Override`](modules.md#override)<`BaseModule`, { `alias?`: `string`[] ; `execute`: (`ctx`: [`Context`](classes/Context.md), `args`: [``"text"``, `string`[]]) => `Awaitable`<`void` \| `unknown`\> ; `onEvent`: [`EventPlugin`](modules.md#eventplugin)<[`Text`](enums/CommandType.md#text)\>[] ; `plugins`: [`CommandPlugin`](modules.md#commandplugin)[] ; `type`: [`Text`](enums/CommandType.md#text) }\> + +#### Defined in + +[src/handler/structures/module.ts:33](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L33) + +## Functions + +### commandModule + +▸ **commandModule**(`mod`): `CommandModule` + +The wrapper function to define command modules for sern + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `mod` | [`InputCommandModule`](modules.md#inputcommandmodule) | + +#### Returns + +`CommandModule` + +#### Defined in + +[src/handler/sern.ts:86](https://github.com/sern-handler/handler/blob/2009593/src/handler/sern.ts#L86) + +___ + +### eventModule + +▸ **eventModule**(`mod`): `EventModule` + +The wrapper function to define event modules for sern + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `mod` | [`InputEventModule`](modules.md#inputeventmodule) | + +#### Returns + +`EventModule` + +#### Defined in + +[src/handler/sern.ts:107](https://github.com/sern-handler/handler/blob/2009593/src/handler/sern.ts#L107) diff --git a/docs/api/namespaces/Sern.md b/docs/api/namespaces/Sern.md new file mode 100644 index 000000000..256c67726 --- /dev/null +++ b/docs/api/namespaces/Sern.md @@ -0,0 +1,114 @@ +--- +id: "Sern" +title: "Namespace: Sern" +sidebar_label: "Sern" +sidebar_position: 0 +custom_edit_url: null +--- + +## References + +### commandModule + +Re-exports [commandModule](../modules.md#commandmodule) + +___ + +### eventModule + +Re-exports [eventModule](../modules.md#eventmodule) + +## Variables + +### controller + +• `Const` **controller**: `Object` + +The object passed into every plugin to control a command's behavior + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `next` | () => `OkImpl`<`void`\> | +| `stop` | () => `ErrImpl`<`void`\> | + +#### Defined in + +[src/handler/sern.ts:77](https://github.com/sern-handler/handler/blob/2009593/src/handler/sern.ts#L77) + +## Functions + +### addExternal + +▸ **addExternal**<`T`\>(`emitter`): `void` + +**`Example`** + +```ts title="src/index.ts" +//Add this before initiating Sern! +Sern.addExternal(new Level()) +``` + +**`Example`** + +```ts title="events/level.ts" + export default eventModule({ + emitter: 'Level', + type : EventType.External, + name: 'error', + execute(args) { + console.log(args) + } + }) +``` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `__module` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | `T` | Any external event emitter. The object will be stored in a map, and then fetched by the name of the instance's class. As there are infinite possibilities to adding external event emitters, Most types aren't provided and are as narrow as possibly can. | + +#### Returns + +`void` + +#### Defined in + +[src/handler/sern.ts:67](https://github.com/sern-handler/handler/blob/2009593/src/handler/sern.ts#L67) + +___ + +### init + +▸ **init**(`wrapper`): `void` + +**`Example`** + +```ts title="src/index.ts" +Sern.init({ + client, + defaultPrefix: '!', + commands: 'dist/commands', +}) +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `wrapper` | [`Wrapper`](../interfaces/Wrapper.md) | Options to pass into sern. Function to start the handler up | + +#### Returns + +`void` + +#### Defined in + +[src/handler/sern.ts:34](https://github.com/sern-handler/handler/blob/2009593/src/handler/sern.ts#L34) diff --git a/docs/api/namespaces/_category_.yml b/docs/api/namespaces/_category_.yml new file mode 100644 index 000000000..1833bbb58 --- /dev/null +++ b/docs/api/namespaces/_category_.yml @@ -0,0 +1,2 @@ +label: "Namespaces" +position: 1 \ No newline at end of file