Interface TransactPlugin

Interface which a [[Session.transact]] plugin must implement.

interface TransactPlugin {
    register: (context: TransactContext) => void;
    translations?: LocaleDefinitions;
    get id(): string;
}

Implemented by

AbstractTransactPlugin

Index

Properties

register translations?

Accessors

Properties

register

register: (context: TransactContext) => void

A function that registers hooks into the transaction flow

`Optional`translations

translations?: LocaleDefinitions

Any translations this plugin requires

Accessors

id

get id(): string
A URL friendly (lower case, no spaces, etc) ID for this plugin - Used in serialization

Returns string
- Defined in packages/session/src/transact.ts:368