Skip to main content
Defined in: packages/shared-influx-pieces/src/lib/structures/InfluxListener.ts:6

​
Extends

  • Listener

​
Constructors

​
Constructor

new InfluxListener(context, options): InfluxListener
Defined in: packages/shared-influx-pieces/src/lib/structures/InfluxListener.ts:9

​
Parameters

context
LoaderContext
options
Options

​
Returns

InfluxListener

​
Overrides

Listener.constructor

​
Properties

​
_listener

protected _listener: (…args) => unknown
Defined in: packages/http-framework/dist/esm/Client-Mni9tJr6.d.ts:1997

​
Parameters

args
…readonly any[]

​
Returns

unknown

​
Inherited from

Listener._listener

​
emitter

emitter: Emitter
Defined in: packages/http-framework/dist/esm/Client-Mni9tJr6.d.ts:1995

​
Inherited from

Listener.emitter

​
enabled

enabled: boolean
Defined in: node_modules/.pnpm/@sapphire+pieces@4.4.1/node_modules/@sapphire/pieces/dist/esm/index.d.mts:234 Whether or not the piece is enabled.

​
Inherited from

Listener.enabled

​
event

event: string
Defined in: packages/http-framework/dist/esm/Client-Mni9tJr6.d.ts:1996

​
Inherited from

Listener.event

​
location

readonly location: PieceLocation
Defined in: node_modules/.pnpm/@sapphire+pieces@4.4.1/node_modules/@sapphire/pieces/dist/esm/index.d.mts:226 The location metadata for the piece’s file.

​
Inherited from

Listener.location

​
name

readonly name: string
Defined in: node_modules/.pnpm/@sapphire+pieces@4.4.1/node_modules/@sapphire/pieces/dist/esm/index.d.mts:230 The name of the piece.

​
Inherited from

Listener.name

​
options

readonly options: Options
Defined in: node_modules/.pnpm/@sapphire+pieces@4.4.1/node_modules/@sapphire/pieces/dist/esm/index.d.mts:238 The raw options passed to this Piece

​
Inherited from

Listener.options

​
store

readonly store: ListenerStore
Defined in: node_modules/.pnpm/@sapphire+pieces@4.4.1/node_modules/@sapphire/pieces/dist/esm/index.d.mts:222 The store that contains the piece.

​
Inherited from

Listener.store

​
tags

tags: [Tags, string][] = []
Defined in: packages/shared-influx-pieces/src/lib/structures/InfluxListener.ts:7

​
Accessors

​
container

​
Get Signature

get container(): Container
Defined in: node_modules/.pnpm/@sapphire+pieces@4.4.1/node_modules/@sapphire/pieces/dist/esm/index.d.mts:244 A reference to the Container object for ease of use.
See
container
Returns
Container

​
Inherited from

Listener.container

​
Methods

​
flush()

flush(): Promise<void>
Defined in: packages/shared-influx-pieces/src/lib/structures/InfluxListener.ts:27

​
Returns

Promise<void>

​
initTags()

protected initTags(): void
Defined in: packages/shared-influx-pieces/src/lib/structures/InfluxListener.ts:38

​
Returns

void

​
injectTags()

protected injectTags(point): Point
Defined in: packages/shared-influx-pieces/src/lib/structures/InfluxListener.ts:31

​
Parameters

point
Point

​
Returns

Point

​
onLoad()

onLoad(): unknown
Defined in: packages/shared-influx-pieces/src/lib/structures/InfluxListener.ts:13 Per-piece listener that is called when the piece is loaded into the store. Useful to set-up asynchronous initialization tasks.

​
Returns

unknown

​
Overrides

Listener.onLoad

​
onUnload()

onUnload(): unknown
Defined in: node_modules/.pnpm/@sapphire+pieces@4.4.1/node_modules/@sapphire/pieces/dist/esm/index.d.mts:254 Per-piece listener that is called when the piece is unloaded from the store. Useful to set-up clean-up tasks.

​
Returns

unknown

​
Inherited from

Listener.onUnload

​
reload()

reload(): Promise<void>
Defined in: node_modules/.pnpm/@sapphire+pieces@4.4.1/node_modules/@sapphire/pieces/dist/esm/index.d.mts:262 Reloads the piece by loading the same path in the store.

​
Returns

Promise<void>

​
Inherited from

Listener.reload

​
run()

abstract run(…args): unknown
Defined in: packages/http-framework/dist/esm/Client-Mni9tJr6.d.ts:1999

​
Parameters

args
…readonly any[]

​
Returns

unknown

​
Inherited from

Listener.run

​
toJSON()

toJSON(): PieceJSON
Defined in: node_modules/.pnpm/@sapphire+pieces@4.4.1/node_modules/@sapphire/pieces/dist/esm/index.d.mts:266 Defines the JSON.stringify behavior of this piece.

​
Returns

PieceJSON

​
Inherited from

Listener.toJSON

​
unload()

unload(): Promise<void>
Defined in: node_modules/.pnpm/@sapphire+pieces@4.4.1/node_modules/@sapphire/pieces/dist/esm/index.d.mts:258 Unloads and disables the piece.

​
Returns

Promise<void>

​
Inherited from

Listener.unload

​
writePoint()

writePoint(point): void
Defined in: packages/shared-influx-pieces/src/lib/structures/InfluxListener.ts:18

​
Parameters

point
Point

​
Returns

void

​
writePoints()

writePoints(points): void
Defined in: packages/shared-influx-pieces/src/lib/structures/InfluxListener.ts:22

​
Parameters

points
readonly Point[]

​
Returns

void