Types

All shared types are exported from sobj/types.

📥 Import

import type {
  SobjBody,
  SobjObject,
  SobjMetadata,
  SobjList,
  SobjRange,
  GetOptions,
  PutOptions,
  ListOptions,
  CopyOptions,
  PresignOptions,
  PresignPutOptions,
  MultipartUpload,
  MultipartPart,
  CreateMultipartOptions,
  ListVersionsOptions,
  SobjVersion,
  SobjVersions,
} from 'sobj/types'

🪹 SobjBody

Accepted body types for uploads.

type SobjBody =
  | string
  | Uint8Array
  | ArrayBuffer
  | Blob
  | ReadableStream<Uint8Array>

📦 SobjObject

Represents a downloaded object.

interface SobjObject {
  readonly body: ReadableStream<Uint8Array>
  readonly metadata: SobjMetadata
}

📝 SobjMetadata

Metadata associated with a stored object.

interface SobjMetadata {
  readonly cacheControl?: string
  readonly contentDisposition?: string
  readonly contentEncoding?: string
  readonly contentLanguage?: string
  readonly contentType?: string
  readonly etag?: string
  readonly key: string
  readonly lastModified?: Date
  readonly metadata?: Readonly<Record<string, string>>
  readonly size?: number
}

Property	Type	Description
`key`	`string`	Object key
`size`	`number`	Size in bytes
`etag`	`string`	ETag / content hash
`contentType`	`string`	MIME type
`lastModified`	`Date`	Last-modified timestamp
`metadata`	`Record<string, string>`	Custom user-defined metadata
`cacheControl`	`string`	Cache-Control header value
`contentDisposition`	`string`	Content-Disposition header value
`contentEncoding`	`string`	Content-Encoding header value
`contentLanguage`	`string`	Content-Language header value

📏 SobjRange

A byte range for partial downloads.

interface SobjRange {
  readonly start?: number
  readonly end?: number
}

📋 SobjList

Result of a list operation.

interface SobjList {
  readonly cursor?: string
  readonly hasMore: boolean
  readonly objects: readonly SobjMetadata[]
  readonly prefixes: readonly string[]
}

Property	Type	Description
`objects`	`SobjMetadata[]`	Objects in this page
`prefixes`	`string[]`	Common prefixes (virtual directories) when using a delimiter
`hasMore`	`boolean`	Whether more results are available
`cursor`	`string`	Cursor to pass to the next `list` call

⚙️ GetOptions

Options for get.

interface GetOptions {
  readonly ifMatch?: string
  readonly ifModifiedSince?: Date
  readonly ifNoneMatch?: string
  readonly ifUnmodifiedSince?: Date
  readonly range?: SobjRange
}

⚙️ PutOptions

Options for put.

interface PutOptions {
  readonly cacheControl?: string
  readonly contentDisposition?: string
  readonly contentEncoding?: string
  readonly contentLanguage?: string
  readonly contentType?: string
  readonly ifMatch?: string
  readonly ifNoneMatch?: string
  readonly metadata?: Readonly<Record<string, string>>
}

⚙️ ListOptions

Options for list.

interface ListOptions {
  readonly cursor?: string
  readonly delimiter?: string
  readonly limit?: number
  readonly prefix?: string
}

⚙️ CopyOptions

Options for copy.

interface CopyOptions {
  readonly cacheControl?: string
  readonly contentType?: string
  readonly metadata?: Readonly<Record<string, string>>
  readonly overwrite?: boolean
}

Set overwrite: false to fail if the destination already exists.

⚙️ PresignOptions

Options for presign.get.

interface PresignOptions {
  readonly expiresIn?: number // seconds, default: 3600
}

⚙️ PresignPutOptions

Options for presign.put.

interface PresignPutOptions extends PresignOptions {
  readonly contentLength?: number
  readonly contentType?: string
}

📦 MultipartUpload

Represents an in-progress multipart upload.

interface MultipartUpload {
  readonly id: string
  readonly key: string
}

📦 MultipartPart

Represents a completed part of a multipart upload.

interface MultipartPart {
  readonly etag: string
  readonly partNumber: number
}

📦 CreateMultipartOptions

Options for multipart.create. Extends PutOptions.

interface CreateMultipartOptions extends PutOptions {}

🏷️ SobjVersion

Represents a specific version of an object.

interface SobjVersion {
  readonly isDeleteMarker?: boolean
  readonly isLatest: boolean
  readonly metadata: SobjMetadata
  readonly version: string
}

🏷️ SobjVersions

Result of versioning.list.

interface SobjVersions {
  readonly cursor?: string
  readonly hasMore: boolean
  readonly versions: readonly SobjVersion[]
}

⚙️ ListVersionsOptions

Options for versioning.list.

interface ListVersionsOptions {
  readonly cursor?: string
  readonly limit?: number
}

Operations — how these types are used
Errors — error types

Types ​

📥 Import ​

🪹 SobjBody ​

📦 SobjObject ​

📝 SobjMetadata ​

📏 SobjRange ​

📋 SobjList ​

⚙️ GetOptions ​

⚙️ PutOptions ​

⚙️ ListOptions ​

⚙️ CopyOptions ​

⚙️ PresignOptions ​

⚙️ PresignPutOptions ​

📦 MultipartUpload ​

📦 MultipartPart ​

📦 CreateMultipartOptions ​

🏷️ SobjVersion ​

🏷️ SobjVersions ​

⚙️ ListVersionsOptions ​

🔗 Related ​