Status

Retrieve status of *code job endpoint.

type ApiStatusFunction = (resource: ApiStatusRequest, opts?: ServerJobOptions) => Promise<DataOrError<(MediaResource|StoredResource)>>

/**
 * A request from the status endpoint of an
 * Api.
 */
interface ApiStatusRequest 
extends MediaResource {
  id: string
  mediaId: string
}

interface ClientJobOptions 
extends JobOptions {
  count?: number
  progress?: JobProgress
  request?: EndpointRequest | string
  user?: string
}

interface JobOptions  {
  user?: string
}

interface JobProduct  {
  createdAt?: number
  id?: string
  type: string
  updatedAt?: number
}

interface JobProgress  {
  did: (steps?: number) => void
  do: (steps?: number) => void
  done: (state?: number) => void
}

interface ServerJobOptions 
extends JobOptions {
  path?: AbsolutePath
  user?: string
}

function jobErrored(
  host: Plugins, 
  id: string, 
  json?: unknown
): Promise<DataOrError<AbsolutePath>>

function jobFinished(
  host: Plugins, 
  id: string, 
  json?: JobProduct
): Promise<DataOrError<AbsolutePath>>

function jobGetStatus(
  host: Plugins, 
  id: string
): Promise<DataOrError<(StoredResource|Date)>>

function jobStarted(
  host: Plugins, 
  id: string, 
  json?: unknown
): Promise<DataOrError<AbsolutePath>>