ITopicApi | mage

Contains the index fields, and methods for processing a given topics on a given vault backend

interface: ITopicApi

Hierarchy

ITopicApi

Index

Properties

Properties

Optional acl

acl: object

Object containing the ACL information, per level

type: {*}
memberof: ITopicApi

Type declaration

[level: string]: object
- ops: VaultOperation | "get" | "*"
- Optional shard?: boolean

Optional createKey

createKey: function

Generate a storage key from the topic name and the index information

memberof: ITopicApi

Type declaration

- (topicName: string, index: IArchivistIndex): any
- Parameters
  - topicName: string
  - index: IArchivistIndex
  Returns any

Optional deserialize

deserialize: function

Deserialize the data

memberof: ITopicApi

Type declaration

- (mediaType: ArchivistMediaType, data: any, encoding: string): any
- Parameters
  - mediaType: ArchivistMediaType
  - data: any
  - encoding: string
  Returns any

index

index: string[]

List of index fields

type: {string[]}
memberof: ITopicApi

Optional serialize

serialize: function

Serialize the data

memberof: ITopicApi

Type declaration

- (value: any): object
- Parameters
  - value: any
  Returns object
  - data: any
  - encoding: string
  - mediaType: ArchivistMediaType

Optional shard

shard: function

Shard function

memberof: ITopicApi

Type declaration

- (value: IVaultValue): string | number
- Parameters
  - value: IVaultValue
  Returns string | number