service/domain/organization/user_permission_revoked

Api Code Documentation / Exports / service/domain/organization/user_permission_revoked

Table of contents#

Interfaces#

Event

Variables#

schema

Functions#

Variables#

schema#

• Const schema: ObjectSchema

Defined in#

src/service/domain/organization/user_permission_revoked.ts:22

Functions#

createEvent#

▸ createEvent(source, publisher, userId, permission, revokee, time?): Type<Event>

Parameters#

Name	Type
`source`	`string`
`publisher`	`string`
`userId`	`string`
`permission`	`default`
`revokee`	`string`
`time`	`string`

Returns#

Type<Event>

Defined in#

src/service/domain/organization/user_permission_revoked.ts:32

mutate#

▸ mutate(user, event): Type<void>

Applies the event to the given user, or returns an error.

When an error is returned (or thrown), any already applied modifications are discarded.

This function is not expected to validate its changes; instead, the modified user is automatically validated when obtained using user_eventsourcing.ts:newUserFromEvent.

Parameters#

Name	Type
`user`	`UserRecord`
`event`	`Event`

Returns#

Type<void>

Defined in#

src/service/domain/organization/user_permission_revoked.ts:73

validate#

▸ validate(input): Type<Event>

Parameters#

Name	Type
`input`	`any`

Returns#

Type<Event>

Defined in#

src/service/domain/organization/user_permission_revoked.ts:58