service/domain/organization/user_permission_granted

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

Table of contents

Interfaces

• Event

Variables

• schema

Functions

• createEvent
• mutate
• validate

Variables

schema

• Const schema: ObjectSchema<any>

Defined in

src/service/domain/organization/user_permission_granted.ts:26

Functions

createEvent

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

Parameters

Name	Type
source	string
publisher	string
userId	string
permission	default
grantee	string
time	string
metadata?	UserMetadata

Returns

Type<Event>

Defined in

src/service/domain/organization/user_permission_granted.ts:37

---

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_granted.ts:80

---

validate

▸ validate(input): Type<Event>

Parameters

Name	Type
input	any

Returns

Type<Event>

Defined in

src/service/domain/organization/user_permission_granted.ts:65