Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Attachment

Represents an attachment and can be used to insert the associated attachment into a document at a specific key.

Hierarchy

  • Attachment

Index

Accessors

Methods

Accessors

metadata

  • get metadata(): {}

  • The attachment's metadata.

    Returns {}

    • [key: string]: string

Methods

copyToPath

  • copyToPath(path: string): Promise<void>

  • Copies the attachment to the specified file path. Node-only, throws in the browser.

    Parameters

    • path: string

      The path that the attachment should be copied to.

    Returns Promise<void>

getData

  • getData(): Promise<Uint8Array>

  • Returns the attachment's data.

    Returns Promise<Uint8Array>