Types
TypeScript type definitions for the Picadabra client.
All types are exported from @picadabra/client/schemas.
Import Types
import type {
,
// Queue types
,
,
,
,
,
,
,
,
// Storage types
,
// User types
,
,
} from '@picadabra/client/schemas'User Types
UserMeOutput
type = {
: string
?: string
}UserStatusOutput
type = {
: true
: string
}Queue Types
QueueStatus
type = 'pending' | 'running' | 'completed' | 'failed' | 'cancelled'QueueTaskOutput
type = {
: string
: 'pending' | 'running' | 'completed' | 'failed' | 'cancelled'
?: <string, unknown>
?: unknown
?: string
: string
?: string
?: string
?: <{
: string
: 'info' | 'warn' | 'error' | 'debug'
: string
}>
?: <string, unknown>
}QueueSubmitOutput
type = {
: string
}QueueCancelOutput
type = {
: boolean
}Storage Types
StorageObjectOutput
type = {
: string
: string
: number
: string
: string
?: string
}StorageCreateUploadUrlOutput
type = {
: string
: string
: string
}StorageCreateMultipartUploadOutput
type = {
: string
: string
: string
}StorageGetDownloadUrlOutput
type = {
: string
: string
}StorageListOutput
type = {
: []
?: string
: boolean
}StorageDeleteOutput
type = {
: boolean
}Health Types
HealthStatusOutput
type = {
: 'ok' | 'degraded'
: string
: {
: 'up' | 'down'
: number
}
}Realtime Types
RealtimeEvent
type = {
: string
: unknown
: string
}ConnectInput
type = {
: string
?: string[]
}PublishInput
type = {
: string
: string
: unknown
?: string[]
}Common Types
PaginationInput
type = {
?: number // 1-100, default 20
?: string
}ExpiresIn
type = '1h' | '1d' | '7d' | '30d' | '1y' | 'never'How is this guide?