Skip to main content

Class: MediaParser

@sapphire/plugin-api.MediaParser

A media parser

since 1.3.0

Hierarchy

  • Piece

    โ†ณ MediaParser

Constructors

constructor

โ€ข new MediaParser(context, options?)

Parameters

NameType
contextPieceContext
options?PieceOptions

Inherited from

Piece.constructor

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:452

Properties

enabled

โ€ข enabled: boolean

Whether or not the piece is enabled.

Inherited from

Piece.enabled

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:447


location

โ€ข Readonly location: PieceLocation

The location metadata for the piece's file.

Inherited from

Piece.location

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:439


name

โ€ข Readonly name: string

The name of the piece.

Inherited from

Piece.name

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:443


options

โ€ข Readonly options: PieceOptions

The raw options passed to this {@link Piece}

Inherited from

Piece.options

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:451


store

โ€ข Readonly store: Store<Piece<PieceOptions>>

The store that contains the piece.

Inherited from

Piece.store

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:435

Accessors

container

โ€ข get container(): Container

A reference to the {@link Container} object for ease of use.

see container

Returns

Container

Inherited from

Piece.container

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:457

Methods

accepts

โ–ธ accepts(route): boolean

Checks if a route accepts the media type from this parser.

since 1.3.0

Parameters

NameTypeDescription
routeRouteThe route to be checked.

Returns

boolean

Defined in

projects/plugins/packages/api/src/lib/structures/MediaParser.ts:24


contentStream

โ–ธ Protected contentStream(request): null | ApiRequest | Gunzip

Reads the content stream from a request, piping the data through a transformer stream.

since 1.3.0

Parameters

NameTypeDescription
requestApiRequestThe request to read the body from.

Returns

null | ApiRequest | Gunzip

Defined in

projects/plugins/packages/api/src/lib/structures/MediaParser.ts:63


onLoad

โ–ธ onLoad(): unknown

Per-piece listener that is called when the piece is loaded into the store. Useful to set-up asynchronous initialization tasks.

Returns

unknown

Inherited from

Piece.onLoad

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:462


onUnload

โ–ธ onUnload(): unknown

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

Piece.onUnload

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:467


readBuffer

โ–ธ Protected readBuffer(request): Promise<Buffer>

Reads the content body as a buffer, this is useful for parsing/reading binary data.

since 1.3.0

Parameters

NameTypeDescription
requestApiRequestThe request to read the body from.

Returns

Promise<Buffer>

Defined in

projects/plugins/packages/api/src/lib/structures/MediaParser.ts:48


readString

โ–ธ Protected readString(request): Promise<string>

Reads the content body as a string, this is useful for parsing/reading plain-text data.

since 1.3.0

Parameters

NameTypeDescription
requestApiRequestThe request to read the body from.

Returns

Promise<string>

Defined in

projects/plugins/packages/api/src/lib/structures/MediaParser.ts:33


reload

โ–ธ reload(): Promise<void>

Reloads the piece by loading the same path in the store.

Returns

Promise<void>

Inherited from

Piece.reload

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:475


run

โ–ธ Abstract run(request): unknown

Parses the body data from an API request.

since 1.3.0

Parameters

NameType
requestApiRequest

Returns

unknown

Defined in

projects/plugins/packages/api/src/lib/structures/MediaParser.ts:17


toJSON

โ–ธ toJSON(): PieceJSON

Defines the JSON.stringify behavior of this piece.

Returns

PieceJSON

Inherited from

Piece.toJSON

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:479


unload

โ–ธ unload(): Promise<void>

Unloads and disables the piece.

Returns

Promise<void>

Inherited from

Piece.unload

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:471