Interface CollectorEvents<T, V>

Type Parameters

T
V extends string | BaseCollectorEndReasons

Hierarchy

CollectorEvents

Index

Methods

collect dispose end ignore

Methods

collect

collect(collected): any
Emitted whenever something is collected.
Parameters
- collected: T
  
  The element collected.
Returns any
- Defined in node_modules/.pnpm/oceanic-collectors@1.0.7/node_modules/oceanic-collectors/dist/structures/Collector.d.ts:7

dispose

dispose(disposed): any
Emitted whenever something is disposed.
Parameters
- disposed: any
  
  The element disposed.
Returns any
- Defined in node_modules/.pnpm/oceanic-collectors@1.0.7/node_modules/oceanic-collectors/dist/structures/Collector.d.ts:12

end

end(collected, reason): any
Emitted whenever the collector stops collecting.
Parameters
- collected: T[]
  
  The data collected by the collector.
- reason: V
  
  The reason the collector has ended.
Returns any
- Defined in node_modules/.pnpm/oceanic-collectors@1.0.7/node_modules/oceanic-collectors/dist/structures/Collector.d.ts:23

ignore

ignore(ignored): any
Emitted whenever something is ignored.
Parameters
- ignored: T
  
  The element ignored.
Returns any
- Defined in node_modules/.pnpm/oceanic-collectors@1.0.7/node_modules/oceanic-collectors/dist/structures/Collector.d.ts:17

Generated using TypeDoc