Class File

constructor

• new File(
      client: Client,
      file:
          | File
          | Pick<
              {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | {
                          animated?: null | boolean;
                          height: number;
                          thumbhash?: null | 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" }
                      | {
                          animated?: null | boolean;
                          height: number;
                          thumbhash?: null | 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

  Construct File

  Parameters

  • client: Client

    Client
  • file:
        | File
        | Pick<
            {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | {
                        animated?: null | boolean;
                        height: number;
                        thumbhash?: null | 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" }
                    | {
                        animated?: null | boolean;
                        height: number;
                        thumbhash?: null | 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 ReadonlycontentType

Optional Readonlyfilename

Readonlyid

Readonlymetadata

Optional Readonlysize

Readonlytag

humanReadableSize

• get humanReadableSize(): string

  Human readable file size

  Returns string

isSpoiler

• get isSpoiler(): boolean

  Whether this file should have a spoiler

  Returns boolean

originalUrl

• get originalUrl(): string

  Original download URL for the file

  Returns string

previewUrl

• get previewUrl(): string

  Preview URL for the file

  Returns string

createFileURL

• createFileURL(forceAnimation?: boolean): undefined | string

  Creates a URL to a given file with given options.

  Parameters

  • OptionalforceAnimation: boolean

    Returns GIF if applicable (for avatars/icons)

  Returns undefined | string

  Generated URL or nothing