Codeboard.
Technical referenceAPI signaturesData shapes

Query types

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

PageOptions

Code
export interface PageOptions {
    limit?: number;
    offset?: number;
}

ObjectQuery

Code
export interface ObjectQuery extends PageOptions {
    name?: string;
    kind?: string;
    panelId?: Id;
    parentId?: Id;
    id?: Id;
}

ObjectSummary

Code
export interface ObjectSummary {
    id: Id;
    kind: string;
    name: string;
    panelId?: Id;
    parentId?: Id;
    nameTruncated?: true;
}

ObjectPageQuery

Code
export interface ObjectPageQuery extends Omit<ObjectQuery, "offset"> {
    cursor?: string;
}

ObjectPage

Code
export interface ObjectPage {
    version: number;
    items: ObjectSummary[];
    nextCursor?: string;
}

Codeboard by Nonom Friedman

Explore Nonom Library

Primitives types

Previous Page

Brushes types

Next Page

On this page

PageOptionsObjectQueryObjectSummaryObjectPageQueryObjectPage