@shopify/cli-kit
    Preparing search index...

    Interface DevInstance

    interface DevInstance {
        abortSignal: AbortSignal;
        info: DevInstanceInfo;
        log: (
            entry: Omit<
                {
                    level?: "info"
                    | "error"
                    | "debug"
                    | "warning";
                    message: string;
                    source: string;
                    timestamp: string;
                },
                "timestamp",
            > & { timestamp?: string },
        ) => Promise<void>;
        paths: DevInstancePaths;
        release: () => Promise<void>;
        tee: (
            target: Writable,
            options: { source: string; stringWritesAreMessages?: boolean },
        ) => Writable;
        update: (changes: DevInstanceUpdate) => Promise<void>;
    }
    Index
    abortSignal info log paths release tee update
    abortSignal: AbortSignal

    Aborts when this session loses its lock or output fails. Consumers must stop their owned work.

    info: DevInstanceInfo
    log: (
        entry: Omit<
            {
                level?: "info"
                | "error"
                | "debug"
                | "warning";
                message: string;
                source: string;
                timestamp: string;
            },
            "timestamp",
        > & { timestamp?: string },
    ) => Promise<void>

    Appends one entry to the JSON Lines log.

    paths: DevInstancePaths
    release: () => Promise<void>

    Closes the log, removes the instance description and releases the lock. Safe to call more than once.

    tee: (
        target: Writable,
        options: { source: string; stringWritesAreMessages?: boolean },
    ) => Writable

    Wraps a stream so every line written to it is also appended to the log, without ANSI styling. The returned stream forwards the original bytes to target unchanged.

    update: (changes: DevInstanceUpdate) => Promise<void>

    Updates and persists the instance description.

    Settings
    Member Visibility

    On This Page
    Properties