Class File

constructor

• new File(client, file): File

• Construct File

  Parameters

  • client: Client

    Client

  • file: Pick<{
        _id: string;
        content_type: string;
        deleted?: null | boolean;
        filename: string;
        message_id?: null | string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: null | string;
        reported?: null | boolean;
        server_id?: null | string;
        size: number;
        tag: string;
        user_id?: null | string;
    }, "_id" | "tag" | "metadata"> & Partial<{
        _id: string;
        content_type: string;
        deleted?: null | boolean;
        filename: string;
        message_id?: null | string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: null | string;
        reported?: null | boolean;
        server_id?: null | string;
        size: number;
        tag: string;
        user_id?: null | string;
    }>

    File

  Returns File

Optional Readonly contentType

Optional Readonly filename

Readonly id

Readonly metadata

Optional Readonly size

Readonly tag

downloadURL

• get downloadURL(): string

• Download URL for the file

  Returns string

humanReadableSize

• get humanReadableSize(): string

• Human readable file size

  Returns string

isSpoiler

• get isSpoiler(): boolean

• Whether this file should have a spoiler

  Returns boolean

url

• get url(): string

• Direct URL to the file

  Returns string

createFileURL

• createFileURL(options?, allowAnimation?): undefined | string

• Creates a URL to a given file with given options.

  Parameters

  • Optional options: {
        height?: number;
        max_side?: number;
        size?: number;
        width?: number;
    }

    Optional query parameters to modify object

    • Optional height?: number

    • Optional max_side?: number

    • Optional size?: number

    • Optional width?: number

  • Optional allowAnimation: boolean

    Returns GIF if applicable, no operations occur on image

  Returns undefined | string

  Generated URL or nothing