Documentation - v0.27.3
    Preparing search index...

    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;
    }
    Index

    Properties

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

    Properties

    arguments: TlArgument[]

    Arguments of the entry

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

    Availability of the method (only if kind is method)

    comment?: string

    Comment of the entry

    generics?: TlGeneric[]

    Generic arguments of the entry

    id: number

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

    kind: "method" | "class"

    Kind of the entry

    name: string

    Name of the entry

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

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

    Type Declaration

    • code: number

      Error code

      429
    • Optionalcomment?: string

      Description of the error

    • name: string

      Error name

      `FLOOD_WAIT_%d`
    type: string

    Type of the entry

    typeModifiers?: TlTypeModifiers

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

    Settings

    Member Visibility

    On This Page

    Properties