Class PassportFile

Hierarchy (view full)

Constructors

constructor

Properties

createdUnixTime id path size uniqueId

Accessors

client createdAt createdTimestamp url

Methods

_clone _patch _update download fetch toJSON valueOf write

Constructors

constructor

  • new PassportFile(client, data): PassportFile

  • Parameters

    • client: TelegramClient | BaseClient

      The client that instantiated this

    • data: PassportFile

      Data about the represents a file uploaded to Telegram Passport. Currently, all Telegram Passport files are in JPEG format when decrypted and do not exceed 10MB

    Returns PassportFile

Properties

createdUnixTime

createdUnixTime: number

Unix time when the file was uploaded

id

id: string

The unique identifier for this file

path

path: null | string

The path to the file on the Telegram server, if available

size

size: null | number

The size of the file in bytes, if available

uniqueId

uniqueId: string

The unique identifier for this file, which is supposed to be consistent across different bots

Accessors

client

createdAt

  • get createdAt(): Date

  • Date when the file was uploaded

    Returns Date

createdTimestamp

  • get createdTimestamp(): number

  • Return the timestamp file was uploaded, in milliseconds

    Returns number

url

  • get url(): null | string

  • Gets the URL to access the file on the Telegram server.

    Returns null | string

Methods

Protected_clone

  • _clone(): Base
  • Protected

    Creates a clone of the current instance

    Returns Base

    A clone of the current instance

Protected_patch

  • _patch(data): Record<string, any>
  • Protected

    Patches the current instance with new data

    Parameters

    • data: Record<string, any>

      The data to patch the instance with

    Returns Record<string, any>

    The patched data

Protected_update

  • _update(data): Base
  • Protected

    Updates the current instance with new data and returns a clone of the updated instance

    Parameters

    • data: Record<string, any>

      The data to update the instance with

    Returns Base

    A clone of the updated instance

download

  • download(): Promise<Buffer>

  • Downloads the file from the Telegram server.

    Returns Promise<Buffer>

    A promise that resolves with the file data as a Buffer.

fetch

toJSON

  • toJSON(propsRecursive?, ...props): Record<string, any>

  • Flatten an object. Any properties that are collections will get converted to an array of keys.

    Parameters

    • OptionalpropsRecursive: boolean

      Optional. If true, calls toJSON method on nested objects.

    • Rest...props: Record<string, string | boolean>[]

      Optional. Specific properties to include/exclude, or rename.

    Returns Record<string, any>

    Flattened object.

valueOf

  • valueOf(): null | string

  • Returns the id instance Chat, User, ChatMember and other

    Returns null | string

write

  • write(path, writeType?, options?): Promise<void>

  • Writes the file to the specified path.

    Parameters

    • path: string

      The path where the file should be written.

    • OptionalwriteType: "promise"

      The type of write operation.

    • Optionaloptions: {
          encoding?: BufferEncoding;
          flag?: string;
          signal?: AbortSignal;
      }

      Additional options for writing the file.

      • Optionalencoding?: BufferEncoding
      • Optionalflag?: string
      • Optionalsignal?: AbortSignal

    Returns Promise<void>

    A promise that resolves when the file has been written.

  • write(path, writeType, options?): Promise<void>

  • Writes the file to the specified path.

    Parameters

    • path: string

      The path where the file should be written.

    • writeType: "stream"

      The type of write operation.

    • Optionaloptions: {
          autoClose?: boolean;
          emitClose?: boolean;
          encoding?: BufferEncoding;
          flush?: boolean;
          highWaterMark?: number;
          start?: number;
      }

      Additional options for writing the file.

      • OptionalautoClose?: boolean
      • OptionalemitClose?: boolean
      • Optionalencoding?: BufferEncoding
      • Optionalflush?: boolean
      • OptionalhighWaterMark?: number
      • Optionalstart?: number

    Returns Promise<void>

    A promise that resolves when the file has been written.

  • write(path, writeType?, options?): Promise<void>

  • Writes the file to the specified path.

    Parameters

    • path: string

      The path where the file should be written.

    • OptionalwriteType: "stream" | "promise"

      The type of write operation.

    • Optionaloptions: undefined

      Additional options for writing the file.

    Returns Promise<void>

    A promise that resolves when the file has been written.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods