ProjectModel
Defined in: packages/core/src/models/project.ts:15
Data operations for project records.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ProjectModel(
db,tables?):ProjectModel
Defined in: packages/core/src/models/project.ts:23
Parameters
Section titled “Parameters”Database adapter.
tables?
Section titled “tables?”ProjectTables
Table handles (injected by the database adapter).
Returns
Section titled “Returns”ProjectModel
Methods
Section titled “Methods”create()
Section titled “create()”create(
input):Promise<Project>
Defined in: packages/core/src/models/project.ts:34
Create a project with a unique slug.
Parameters
Section titled “Parameters”Project creation input.
Returns
Section titled “Returns”Promise<Project>
The created project.
get(
id):Promise<Project|null>
Defined in: packages/core/src/models/project.ts:56
Fetch a project by id, or null if not found.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Project | null>
getBySlug()
Section titled “getBySlug()”getBySlug(
slug):Promise<Project|null>
Defined in: packages/core/src/models/project.ts:61
Fetch a project by its slug, or null if not found.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Project | null>
list()
Section titled “list()”list():
Promise<Project[]>
Defined in: packages/core/src/models/project.ts:70
List all projects.
Returns
Section titled “Returns”Promise<Project[]>
remove()
Section titled “remove()”remove(
id):Promise<void>
Defined in: packages/core/src/models/project.ts:98
Delete a project by id.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
update()
Section titled “update()”update(
id,patch):Promise<Project>
Defined in: packages/core/src/models/project.ts:75
Update mutable fields of a project.
Parameters
Section titled “Parameters”string
Partial<Omit<Project, "storybookMeta">> & object
Returns
Section titled “Returns”Promise<Project>