Class Attachment<P, Type>

constructor

• new Attachment<P, Type>(options): Attachment<P, Type>

• Constructor

  Type Parameters

  • P = object

  • Type extends string = string

  Parameters

  • options: IAttachmentOptions<P, Type>

  Returns Attachment<P, Type>

type

[toStringTag]

• get [toStringTag](): string

• Returns custom tag

  Returns string

accessKey

• get accessKey(): undefined | string

• Returns undefined | string

canBeAttached

• get canBeAttached(): boolean

• Can be attached via string representation

  Returns boolean

id

• get id(): number

• Returns number

isFilled

• get isFilled(): boolean

• Returns whether the attachment is filled

  Returns boolean

ownerId

• get ownerId(): number

• Returns number

[kSerializeData]

• [kSerializeData](): object

• Returns the custom data

  Returns object

equals

• equals(attachment): boolean

• Checks that the attachment is equivalent with object

  Parameters

  • attachment: string | Attachment<object, string>

  Returns boolean

toJSON

• toJSON(): object

• Returns data for JSON

  Returns object

toString

• toString(): string

• Returns a string to attach a VK

  Returns string

Static fromString

• fromString(attachment, api): Attachment<object, string>

• Parse attachment with string

  Parameters

  • attachment: string

  • api: API

  Returns Attachment<object, string>