Home > @unseenco/backstage-core > IProject

IProject interface

A Backstage.js project

Signature:

export interface IProject

Properties

Property	Modifiers	Type	Description
address		ProjectAddress	The project's address
isReady		boolean	Shows whether the project is ready to be used. Better to use IProject.ready, which is a promise that would resolve when the project is ready.
ready		Promise<void>	If @unseenco/backstage/studio is used, this promise would resolve when studio has loaded the state of the project into memory. If @unseenco/backstage/studio is not used, this promise is already resolved.
type		'Backstage_Project_PublicAPI'	Discriminator for Backstage.js public project instances.

Methods

Method	Description
getAssetUrl(asset)	Returns the URL for an asset.
getSheets()	Returns all currently loaded sheet instances under this project. Use with ISheet.detachObject() or ISheet.unload() to tear down individual sheets/objects at runtime. Persisted project state is not cleared.
sheet(sheetId, instanceIdOrOpts)	Creates a Sheet under the project
sheet(sheetId, instanceId, opts)	Creates a Sheet under the project (overload with explicit instanceId).
unloadSheet(sheetId, instanceId)	Unloads one sheet and its attached objects from memory. Runtime-only: persisted prop overrides and sequence data are kept. Calling again with the same sheetId recreates the sheet.
unloadSheets()	Unloads every currently loaded sheet and its objects from memory. Runtime-only: persisted project state is kept.