@basetenlabs/sandbox - v0.3.0
    Preparing search index...

    Interface ImageLibraryInfo

    A built-in image available to every team, usable as a sandbox's image without building or pushing it. From ImageClient.listLibrary.

    interface ImageLibraryInfo {
        categories: string[];
        creationExtraArgs?: Record<string, string>;
        creationVolumes: ImageLibraryVolume[];
        description?: string;
        displayName?: string;
        enterprise: boolean;
        icon?: string;
        iconDark?: string;
        iconLight?: string;
        image: string;
        longDescription?: string;
        memory?: number;
        name: string;
        ports: SandboxPort[];
        tags: string[];
        url?: string;
    }
    Index
    categories creationExtraArgs? creationVolumes description? displayName? enterprise icon? iconDark? iconLight? image longDescription? memory? name ports tags url?
    categories: string[]
    creationExtraArgs?: Record<string, string>

    Kernel selection arguments suggested when creating a sandbox from this image. Creating a sandbox cannot pass these yet.

    creationVolumes: ImageLibraryVolume[]

    Volume attachments suggested when creating a sandbox from this image. Creating a sandbox cannot pass these yet.

    description?: string

    Short description.

    displayName?: string

    Human-readable name.

    enterprise: boolean

    Whether the image requires an enterprise plan.

    icon?: string

    Icon URL.

    iconDark?: string

    Dark-mode icon URL.

    iconLight?: string

    Light-mode icon URL.

    image: string

    Image reference including its tag, to pass as SandboxCreateRequest.image.

    longDescription?: string

    Detailed description.

    memory?: number

    Recommended memory allocation in megabytes.

    name: string

    Stable identifier of the image.

    ports: SandboxPort[]

    Ports the image exposes.

    tags: string[]
    url?: string

    Documentation URL.

    Settings
    Member Visibility

    On This Page
    Properties