Skip to content
View as Markdown

Snapshot

Section titled “Snapshot”

Properties:

  • id string
  • name string
  • class ArtifactClass
  • kind SnapshotKind
  • rawKind string
  • availableIn string[]
  • status string
  • error? string | null
  • createdAt string
  • updatedAt string
  • memoryBytes? number
  • sandboxId? string

Constructors

Section titled “Constructors”

Constructor

Section titled “Constructor”
new Snapshot(snapshot: api.SnapshotRow): Snapshot;

Parameters:

  • snapshot api.SnapshotRow

Returns:

  • Snapshot

SnapshotsService

Section titled “SnapshotsService”

Constructors

Section titled “Constructors”

Constructor

Section titled “Constructor”
new SnapshotsService(http: AxiosInstance): SnapshotsService;

Parameters:

  • http AxiosInstance

Returns:

  • SnapshotsService

Methods

Section titled “Methods”

delete()

Section titled “delete()”
delete(snapshotId: string): Promise<void>;

Parameters:

  • snapshotId string

Returns:

  • Promise<void>

get()

Section titled “get()”
get(
   snapshotId: string,
   options: { wait?: 'ready'; timeout?: number } = {}): Promise<Snapshot>;

Parameters:

  • snapshotId string
  • options { wait?: ‘ready’; timeout?: number } = {}

Returns:

  • Promise<Snapshot>

iter()

Section titled “iter()”
iter(
   options: { cursor?: string; limit?: number; name?: string; sandboxId?: string } = {}): AsyncIterable<Snapshot>;

Parameters:

  • options { cursor?: string; limit?: number; name?: string; sandboxId?: string } = {}

Returns:

  • AsyncIterable<Snapshot>

list()

Section titled “list()”
list(
   options: { cursor?: string; limit?: number; name?: string; sandboxId?: string } = {}): Promise<ListResult<Snapshot>>;

Parameters:

  • options { cursor?: string; limit?: number; name?: string; sandboxId?: string } = {}

Returns:

  • Promise<ListResult<Snapshot>>