Storage types

Data shapes for storage. See all type groups for other domains and shared units. Import public types from codeboard-studio; helper shapes are included to explain nested values.

CopyProjectOptions

Code

export interface CopyProjectOptions {
    expectedVersion: number;
    maxBytes?: number;
    signal?: AbortSignal;
}

Code

export type Header = Omit<StoryboardDocument, "panels" | "components" | "changes" | "studio">;

PanelInfo

Code

export type PanelInfo = Omit<Panel, "layers" | "motion">;

SaveOptions

Code

export type SaveOptions = {
    expectedVersion?: number;
    overwrite?: boolean;
    assetRoot?: string;
    readAsset?: (id: string) => Buffer | undefined;
};

CopyProjectOptionsCopy Anchor Link

HeaderCopy Anchor Link

PanelInfoCopy Anchor Link

SaveOptionsCopy Anchor Link

On this page

CopyProjectOptions

Header

PanelInfo

SaveOptions