SubmissionManager

Hierarchy

EventEmitter
- SubmissionManager

Index

Constructors

constructor

Events

READY

Properties

Accessors

ready

Constructors

constructor

new SubmissionManager(client: default): SubmissionManager

Overrides EventEmitter.constructor
- Defined in src/modules/managers/submissions.ts:14
Parameters
- client: default
Returns SubmissionManager

Events

Static READY

READY: "ready" = 'ready'

Ready event.

Properties

Private _ready

_ready: boolean = false

cache

cache: Collection<string, Submission>

client

client: default

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof 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.

Accessors

ready

get ready(): boolean

- Defined in src/modules/managers/submissions.ts:109
A boolean indicating whether client is ready.

Returns boolean

Methods

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): SubmissionManager

Inherited from EventEmitter.addListener
- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SubmissionManager

create

create(submissionConfig: Omit<SubmissionConfig, "_id"> | Omit<SubmissionConfig, "_id">[], cache?: boolean): Promise<Submission[]>

- Defined in src/modules/managers/submissions.ts:51
Create a new submission(s).

Parameters
- submissionConfig: Omit<SubmissionConfig, "_id"> | Omit<SubmissionConfig, "_id">[]
  
  Submission(s) metadata.
- cache: boolean = true
  
  Caches parsed object from response. Default true.
Returns Promise<Submission[]>

A promise that resolves to an Array of submission objects.

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit
- Defined in node_modules/@types/node/events.d.ts:82
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:87
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:79
Returns number

listenerCount

listenerCount(event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:83
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:80
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): SubmissionManager

Inherited from EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SubmissionManager

on

on(event: string | symbol, listener: (...args: any[]) => void): SubmissionManager

Inherited from EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SubmissionManager

once

once(event: string | symbol, listener: (...args: any[]) => void): SubmissionManager

Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:74
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SubmissionManager

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): SubmissionManager

Inherited from EventEmitter.prependListener
- Defined in node_modules/@types/node/events.d.ts:85
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SubmissionManager

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): SubmissionManager

Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:86
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SubmissionManager

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:81
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): SubmissionManager

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:77
Parameters
- Optional event: string | symbol
Returns SubmissionManager

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): SubmissionManager

Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns SubmissionManager

resolve

resolve(submission: SubmissionResolvable): undefined | Submission

- Defined in src/modules/managers/submissions.ts:28
Resolve a resolvable to a matching object.

Parameters
- submission: SubmissionResolvable
  
  Submission resolvable to resolve.
Returns undefined | Submission

Submission object or undefined.

resolveID

resolveID(submission: SubmissionResolvable): undefined | string

- Defined in src/modules/managers/submissions.ts:38
Resolve a resolvable to a matching object ID.

Parameters
- submission: SubmissionResolvable
  
  Submission resolvable to resolve.
Returns undefined | string

Submission ID or undefined.

setMaxListeners

setMaxListeners(n: number): SubmissionManager

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:78
Parameters
- n: number
Returns SubmissionManager

Static getEventListener

getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

Inherited from EventEmitter.getEventListener
- Defined in node_modules/@types/node/events.d.ts:34
Returns a list listener for a specific emitter event name.

Parameters
- emitter: DOMEventTarget | EventEmitter
- name: string | symbol
Returns Function[]

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:30
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

Inherited from EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:27
Parameters
- emitter: EventEmitter
- event: string
- Optional options: StaticEventEmitterOptions
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>

Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:25
Parameters
- emitter: NodeEventTarget
- event: string | symbol
- Optional options: StaticEventEmitterOptions
Returns Promise<any[]>
Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: DOMEventTarget
- event: string
- Optional options: StaticEventEmitterOptions
Returns Promise<any[]>

Hierarchy

Index

Constructors

Events

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: default

Returns SubmissionManager

Events

Static READY

Properties

Private _ready

cache

client

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Accessors

ready

Returns boolean

Methods

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns SubmissionManager

create

Parameters

submissionConfig: Omit<SubmissionConfig, "_id"> | Omit<SubmissionConfig, "_id">[]

cache: boolean = true

Returns Promise<Submission[]>

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

off

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns SubmissionManager

on

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns SubmissionManager

once

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns SubmissionManager