Interface ClientInterface

The interface that any auditor client must implement

interface ClientInterface {
    create(ev): Promise<void>;
    read(ev): Promise<void>;
    update<T>(ev): Promise<void>;
    delete(ev): Promise<void>;
    diff<T>(prev, next, rels): Changes<T>;
}

Index

Methods

create read update delete diff

Methods

create

create(ev): Promise<void>
Parameters
- ev: SubmittedEvent<CreatedEvent>
Returns Promise<void>
- Defined in Audit.ts:104

read

read(ev): Promise<void>
Parameters
- ev: SubmittedEvent<BaseDataEvent>
Returns Promise<void>
- Defined in Audit.ts:105

update

update<T>(ev): Promise<void>
Type Parameters
- T
Parameters
- ev: SubmittedEvent<UpdatedEvent<T>>
Returns Promise<void>
- Defined in Audit.ts:106

delete

delete(ev): Promise<void>
Parameters
- ev: SubmittedEvent<BaseDataEvent>
Returns Promise<void>
- Defined in Audit.ts:107

diff

diff<T>(prev, next, rels): Changes<T>
Type Parameters
- T
Parameters
- prev: undefined | null | T
- next: Partial<T>
- rels: {
  [k in string | number | symbol]?: string
  }
Returns Changes<T>
- Defined in Audit.ts:108

Generated using TypeDoc