Class: abstract MediaParser<Options>
A media parser
Since
1.3.0
Extends
Piece<Options,"mediaParsers">
Type Parameters
| Type Parameter | Default type |
|---|---|
Options extends Options | Options |
Constructors
new MediaParser()
new MediaParser<
Options>(context:LoaderContext,options:Options):MediaParser<Options>
Parameters
| Parameter | Type |
|---|---|
context | LoaderContext |
options | Options |
Returns
MediaParser<Options>
Overrides
Piece<Options, 'mediaParsers'>.constructor
Defined in
projects/plugins/packages/api/src/lib/structures/MediaParser.ts:13
Methods
accepts()
accepts(
route:Route<RouteOptions>):boolean
Checks if a route accepts the media type from this parser.
Parameters
| Parameter | Type | Description |
|---|---|---|
route | Route<RouteOptions> | The route to be checked. |
Returns
boolean
Since
1.3.0
Defined in
projects/plugins/packages/api/src/lib/structures/MediaParser.ts:28
contentStream()
protectedcontentStream(request:ApiRequest):null|ApiRequest|Gunzip
Reads the content stream from a request, piping the data through a transformer stream.
Parameters
| Parameter | Type | Description |
|---|---|---|
request | ApiRequest | The request to read the body from. |
Returns
null | ApiRequest | Gunzip
Since
1.3.0
Defined in
projects/plugins/packages/api/src/lib/structures/MediaParser.ts:67
readBuffer()
protectedreadBuffer(request:ApiRequest):Promise<Buffer>
Reads the content body as a buffer, this is useful for parsing/reading binary data.
Parameters
| Parameter | 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:52
readString()
protectedreadString(request:ApiRequest):Promise<string>
Reads the content body as a string, this is useful for parsing/reading plain-text data.
Parameters
| Parameter | 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:37
run()
abstractrun(request:ApiRequest):unknown
Parses the body data from an API request.
Parameters
| Parameter | Type |
|---|---|
request | ApiRequest |
Returns
unknown
Since
1.3.0
Defined in
projects/plugins/packages/api/src/lib/structures/MediaParser.ts:21