Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-16 11:33:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat(builders): multipart form data output support (#11248)

Browse Source 
* feat(builders): multipart form data output support

* refactor: proper key management

* chore: add missing remarks

* chore: requested changes

* chore: rename encodables file

* chore: requested changes

* chore: requested changes

* chore: nits

Co-authored-by: Almeida <github@almeidx.dev>

* chore: requested change

* chore: requested change

---------

Co-authored-by: Almeida <github@almeidx.dev>
This commit is contained in:
Denis-Adrian Cristea
2025-11-19 23:59:51 +02:00
committed by GitHub
parent 315f422781
commit 68bb8af58a
10 changed files with 277 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
packages/util/src/encodables.ts Normal file
View File

@@ -0,0 +1,61 @@
import type { RawFile } from './RawFile.js';
/**
* Represents an object capable of representing itself as a JSON object
*
* @typeParam Value - The JSON type corresponding to {@link JSONEncodable.toJSON} outputs.
*/
export interface JSONEncodable<Value> {
/**
* Transforms this object to its JSON format
*/
toJSON(): Value;
}
/**
* Indicates if an object is encodable or not.
*
* @param maybeEncodable - The object to check against
*/
export function isJSONEncodable(maybeEncodable: unknown): maybeEncodable is JSONEncodable<unknown> {
return maybeEncodable !== null && typeof maybeEncodable === 'object' && 'toJSON' in maybeEncodable;
}
/**
* Result of encoding an object that includes file attachments
*
* @typeParam BodyValue - The JSON body type
*/
export interface FileBodyEncodableResult<BodyValue> {
/**
* The JSON body to send with the request
*/
body: BodyValue;
/**
* The files to attach to the request
*/
files: RawFile[];
}
/**
* Represents an object capable of representing itself as a request body with file attachments.
* Objects implementing this interface can separate JSON body data from binary file data,
* which is necessary for multipart/form-data requests.
*
* @typeParam BodyValue - The JSON body type
*/
export interface FileBodyEncodable<BodyValue> {
/**
* Transforms this object to its file body format, separating the JSON body from file attachments.
*/
toFileBody(): FileBodyEncodableResult<BodyValue>;
}
/**
* Indicates if an object is file body encodable or not.
*
* @param maybeEncodable - The object to check against
*/
export function isFileBodyEncodable(maybeEncodable: unknown): maybeEncodable is FileBodyEncodable<unknown> {
return maybeEncodable !== null && typeof maybeEncodable === 'object' && 'toFileBody' in maybeEncodable;
}