Interface TlEntry

A TL entry

interface TlEntry {
    arguments: TlArgument[];
    available?: "both" | "bot" | "user";
    comment?: string;
    generics?: TlGeneric[];
    id: number;
    kind: "method" | "class";
    name: string;
    throws?: { code: number; comment?: string; name: string }[];
    type: string;
    typeModifiers?: TlTypeModifiers;
}

Properties

arguments available? comment? generics? id kind name throws? type typeModifiers?

Properties

arguments

arguments: TlArgument[]

Arguments of the entry

Optionalavailable

available?: "both" | "bot" | "user"

Availability of the method (only if kind is method)

Optionalcomment

comment?: string

Comment of the entry

Optionalgenerics

generics?: TlGeneric[]

Generic arguments of the entry

id

id: number

ID of the entry (may be 0 if not known)

kind

kind: "method" | "class"

Kind of the entry

name

name: string

Name of the entry

Optionalthrows

throws?: { code: number; comment?: string; name: string }[]

Errors that this method can throw (only if kind is method)

Type declaration

  • code: number

    Error code

    Example

    429
  • Optionalcomment?: string

    Description of the error

  • name: string

    Error name

    Example

    `FLOOD_WAIT_%d`

type

type: string

Type of the entry

OptionaltypeModifiers

typeModifiers?: TlTypeModifiers

For methods (where type is the return type), modifiers for type

Settings

Member Visibility

On This Page

Properties