basalt / activity/src / ActivityBuilder
Class: ActivityBuilder
Defined in: activity/src/index.ts:64
Fluent builder:
await activity.in('project') .performedOn('project', project.id) .withProperties({ from: 'draft', to: 'published' }) .log('published')
Constructors
Constructor
> new ActivityBuilder(store, logName): ActivityBuilder
Defined in: activity/src/index.ts:70
Parameters
store
logName
string
Returns
ActivityBuilder
Methods
causedBy()
> causedBy(userId): this
Defined in: activity/src/index.ts:82
Overrides the causer (defaults to ctx().user.id).
Parameters
userId
string
Returns
this
log()
> log(description): Promise<ActivityRecord>
Defined in: activity/src/index.ts:92
Parameters
description
string
Returns
Promise<ActivityRecord>
performedOn()
> performedOn(type, id): this
Defined in: activity/src/index.ts:75
Parameters
type
string
id
string
Returns
this
withProperties()
> withProperties(properties): this
Defined in: activity/src/index.ts:87
Parameters
properties
Record<string, unknown>
Returns
this