Class: MediaParser
@sapphire/plugin-api.MediaParser
A media parser
Since
1.3.0
Hierarchy
Piece↳
MediaParser
Constructors
constructor
• new MediaParser(context, options?)
Parameters
| Name | Type |
|---|---|
context | PieceContext |
options? | PieceOptions |
Inherited from
Piece.constructor
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:455
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:450
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:442
name
• Readonly name: string
The name of the piece.
Inherited from
Piece.name
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:446
options
• Readonly options: PieceOptions
The raw options passed to this Piece
Inherited from
Piece.options
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:454
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:438
Accessors
container
• get container(): Container
A reference to the Container object for ease of use.
Returns
Container
See
container
Inherited from
Piece.container
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:460
Methods
accepts
▸ accepts(route): boolean
Checks if a route accepts the media type from this parser.
Parameters
| Name | Type | Description |
|---|---|---|
route | Route | The route to be checked. |
Returns
boolean
Since
1.3.0
Defined in
projects/plugins/packages/api/src/lib/structures/MediaParser.ts:24
contentStream
▸ Protected contentStream(request): null | BrotliDecompress | ApiRequest
Reads the content stream from a request, piping the data through a transformer stream.
Parameters
| Name | Type | Description |
|---|---|---|
request | ApiRequest | The request to read the body from. |
Returns
null | BrotliDecompress | ApiRequest
Since
1.3.0
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:465
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:470
readBuffer
▸ Protected readBuffer(request): Promise<Buffer>
Reads the content body as a buffer, this is useful for parsing/reading binary data.
Parameters
| Name | Type | Description |
|---|---|---|
request | ApiRequest | The request to read the body from. |
Returns
Promise<Buffer>
Since
1.3.0
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.
Parameters
| Name | Type | Description |
|---|---|---|
request | ApiRequest | The request to read the body from. |
Returns
Promise<string>
Since
1.3.0
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:478
run
▸ Abstract run(request): unknown
Parses the body data from an API request.
Parameters
| Name | Type |
|---|---|
request | ApiRequest |
Returns
unknown
Since
1.3.0
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:482
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:474