Class Photo

Hierarchy (view full)

InputFile
- Photo

Index

Constructors

Properties

height id path size uniqueId width

Accessors

Methods

_clone _patch _update download fetch toJSON valueOf write

Constructors

constructor

new Photo(client, data): Photo
Parameters
- client: TelegramClient | BaseClient
  The client that instantiated this
- data: PhotoSize
  Data about the represents one size of a photo or a file / sticker thumbnail
Returns Photo
Overrides InputFile.constructor

Properties

height

height: number

Photo height

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

width

width: number

Photo width

Accessors

client

get client(): TelegramClient
The client that instantiated this

Returns TelegramClient
Inherited from InputFile.client

url

get url(): null | string
Gets the URL to access the file on the Telegram server.

Returns null | string
Inherited from InputFile.url

Methods

`Protected`_clone

_clone(): Base
Protected
Creates a clone of the current instance

Returns Base
A clone of the current instance

Inherited from InputFile._clone

`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

Inherited from InputFile._patch

`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

Inherited from InputFile._update

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.

Inherited from InputFile.download

fetch

fetch(): Promise<InputFile>
Fetch about the file

Returns Promise<InputFile>
Inherited from InputFile.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.

Inherited from InputFile.toJSON

valueOf

valueOf(): null | string
Returns the id instance Chat, User, ChatMember and other

Returns null | string
Inherited from InputFile.valueOf

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.

Inherited from InputFile.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.
- 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.

Inherited from InputFile.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: "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.

Inherited from InputFile.write