mage
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Interfaces

Type aliases

Type aliases

ArchivistDistributeCallback

ArchivistDistributeCallback: function

Type declaration

    • (preDistributionErrors: Error[], distributionErrors: Error[]): void

    • Parameters

      • preDistributionErrors: Error[]
      • distributionErrors: Error[]

      Returns void

ArchivistEncoding

ArchivistEncoding: "utf8" | "buffer" | "live"

Defines to what type of data structure a topic instance will be deserialized into. It is also used in some cases to specify to a serialization method what is the data type of the data we are feeding in.

ArchivistExistsCallback

ArchivistExistsCallback: function

Callback functions

Type declaration

    • (error: Error | null, doesValueExist: boolean): void

    • Parameters

      • error: Error | null
      • doesValueExist: boolean

      Returns void

ArchivistGetCallback

ArchivistGetCallback: function

Type declaration

    • (error: Error | null, value: T): void

    • Parameters

      • error: Error | null
      • value: T

      Returns void

ArchivistListCallback

ArchivistListCallback: function

Type declaration

ArchivistMGetCallback

ArchivistMGetCallback: function

Type declaration

    • (error: Error | null, value: T[]): void

    • Parameters

      • error: Error | null
      • value: T[]

      Returns void

ArchivistMediaType

ArchivistMediaType: "application/json" | "application/octet-stream" | "application/x-tome" | "text/plain" | string

The media type defines how the data will be deserialized when read from a topic, and how it will be serialized before it is written to a topic.

ArchivistNamedMGetCallback

ArchivistNamedMGetCallback: function

Type declaration

    • (error: Error | null, value: object): void

    • Parameters

      • error: Error | null
      • value: object
        • [name: string]: T

      Returns void

ArchivistScanOptions

ArchivistScanOptions: IArchivistGetOptions & IArchivistListOptions

Scans can set options for both listing and getting.