constructor: function

• new __type(actorId?: string, session?: Session, options?: IStateOptions): IState

• Parameters

  • Optional actorId: string

  • Optional session: Session

  • Optional options: IStateOptions

  Returns IState

assertTopicAbilities: function

• assertTopicAbilities(topicName: string, index?: string[], requiredOperations?: string[], isIndexPartial?: boolean): any

• Parameters

  • topicName: string

  • Optional index: string[]

  • Optional requiredOperations: string[]

  • Optional isIndexPartial: boolean

  Returns any

closeVaults: function

• closeVaults(): any

• Returns any

getPersistentVaults: function

• getPersistentVaults(): object

• Returns object

  • [vaultName: string]: any

getTopicApi: function

• getTopicApi(topicName: string, vaultName: string): ITopicApi | null

• Parameters

  • topicName: string

  • vaultName: string

  Returns ITopicApi | null

getTopics: function

• getTopics(): object

• Returns object

  • [topicName: string]: ITopic

migrateToVersion: function

• migrateToVersion(targetVersion: string, callback: function): any

• Parameters

  • targetVersion: string

  • callback: function

    • • (error: Error | null): void

      • Parameters

        • error: Error | null

        Returns void

  Returns any

topicExists: function

• topicExists(topicName: string): boolean

• Parameters

  • topicName: string

  Returns boolean

addRoute: function

• addRoute(pathMatch: string | RegExp, handlerFunction: function, type: "simple" | "callback" | "websocket" | "proxy"): void

• Parameters

  • pathMatch: string | RegExp

  • handlerFunction: function

    • • (...args: any[]): any

      • Parameters

        • Rest ...args: any[]

        Returns any

  • type: "simple" | "callback" | "websocket" | "proxy"

  Returns void

delRoute: function

• delRoute(pathMatch: string | RegExp): void

• Parameters

  • pathMatch: string | RegExp

  Returns void

serveFile: function

• serveFile(route: string | RegExp, filePath: string, onFinish?: function): void

• Parameters

  • route: string | RegExp

  • filePath: string

  • Optional onFinish: function

    • • (error?: Error): void

      • Parameters

        • Optional error: Error

        Returns void

  Returns void

serveFolder: function

• serveFolder(route: string | RegExp, folderPath: string, defaultFile?: string, onFinish?: function): void

• Parameters

  • route: string | RegExp

  • folderPath: string

  • Optional defaultFile: string

  • Optional onFinish: function

    • • (error?: Error): void

      • Parameters

        • Optional error: Error

        Returns void

  Returns void

setFavicon: function

• setFavicon(buffer: Buffer, mimetype?: string): void

• Parameters

  • buffer: Buffer

  • Optional mimetype: string

  Returns void

mmrp: object

• Envelope: MmrpEnvelope

• MmrpNode: MmrpNode

broadcast: function

• broadcast(message: MmrpEnvelope): void

• Parameters

  • message: MmrpEnvelope

  Returns void

close: function

• close(): void

• Returns void

confirm: function

• confirm(address: string, clusterId: string, msgIds: string[]): void

• Parameters

  • address: string

  • clusterId: string

  • msgIds: string[]

  Returns void

connect: function

• connect(address: string, clusterId: string, disconnects?: "never" | "always" | "ondelivery"): void

• Parameters

  • address: string

  • clusterId: string

  • Optional disconnects: "never" | "always" | "ondelivery"

  Returns void

disconnect: function

• disconnect(address: string, clusterId: string): void

• Parameters

  • address: string

  • clusterId: string

  Returns void

getClusterId: function

• getClusterId(): string

• Returns string

getMmrpNode: function

• getMmrpNode(): MmrpNode

• Returns MmrpNode

getPublicConfig: function

• getPublicConfig(): any

• Returns any

isEnabled: function

• isEnabled(): boolean

• Returns boolean

send: function

• send(address: string, clusterId: string, message: MmrpEnvelope): void

• Parameters

  • address: string

  • clusterId: string

  • message: MmrpEnvelope

  Returns void

inc: function

• inc(path: string[], id: string, increment: number): void

• Parameters

  • path: string[]

  • id: string

  • increment: number

  Returns void

sample: function

• sample(path: string[], id: string, value: number): void

• Parameters

  • path: string[]

  • id: string

  • value: number

  Returns void

set: function

• set(path: string[], id: string, value: number): void

• Parameters

  • path: string[]

  • id: string

  • value: number

  Returns void

timedSample: function

• timedSample(path: string[], id: string, delta: number): void

• Parameters

  • path: string[]

  • id: string

  • delta: number

  Returns void

createService: function

• createService(name: string, type: "tcp" | "udp"): IService

• Parameters

  • name: string

  • type: "tcp" | "udp"

  Returns IService