Function: createLabel()

createLabel(args): Promise<{ id: LixGenerated<string>; name: string; }>

Creates a label that can be attached to change sets.

Labels help categorise change sets, for example "checkpoint" or "reviewed". They are simple name identifiers stored per version.

Parameters

args

id?

LixGenerated<string>

lix

Pick<Lix, "db">

lixcol_version_id?

string

name

string

Returns

Promise<{ id: LixGenerated<string>; name: string; }>

Example

const label = await createLabel({ lix, name: "checkpoint" })