nextspace
    Preparing search index...

    Interface UseArtifactsReturn

    State and controls the useArtifacts hook provides.

    interface UseArtifactsReturn {
        artifacts: Artifact[];
        error: string | null;
        liveArtifactIds: Set<string>;
        loading: boolean;
        needsPasscode: boolean;
        reload: () => void;
    }
    Index

    Properties

    artifacts: Artifact[]

    The container's artifacts, newest first, each at its latest version.

    error: string | null

    Why the list could not be read, or null.

    liveArtifactIds: Set<string>

    Ids whose current version arrived over the socket since load, so the UI can mark what just changed.

    loading: boolean

    True while the first (or a re-issued) list request is in flight.

    needsPasscode: boolean

    True when the read was refused for want of a passcode, which is the only actionable reading of the endpoint's 403.

    reload: () => void

    Re-fetches the list.