sobj

Operations ​

All operations are defined in the SobjOperations interface. Adapters implement whichever operations they support.

📥 Import ​

ts
import type { SobjOperations } from 'sobj/operations'

📤 put ​

Upload an object.

ts
put(key: string, body: SobjBody, options?: PutOptions): Promise<SobjMetadata>

📋 Parameters ​

ParameterTypeDescription
keystringObject key
bodySobjBodyObject content
optionsPutOptionsUpload options

📦 Returns ​

SobjMetadata — metadata of the uploaded object.

📥 get ​

Download an object. Returns null if the object does not exist.

ts
get(key: string, options?: GetOptions): Promise<SobjObject | null>

📋 Parameters ​

ParameterTypeDescription
keystringObject key
optionsGetOptionsDownload options

📦 Returns ​

SobjObject or null.

🔍 head ​

Get metadata for an object without downloading its body. Returns null if not found.

ts
head(key: string): Promise<SobjMetadata | null>

📋 Parameters ​

ParameterTypeDescription
keystringObject key

📦 Returns ​

SobjMetadata or null.

🗑️ delete ​

Remove an object.

ts
delete(key: string): Promise<void>

📋 Parameters ​

ParameterTypeDescription
keystringObject key

📋 list ​

List objects in the storage.

ts
list(options?: ListOptions): Promise<SobjList>

📋 Parameters ​

ParameterTypeDescription
optionsListOptionsListing options

📦 Returns ​

SobjList — page of objects and optional cursor.

📂 copy ​

Copy an object to a new key.

ts
copy(source: string, destination: string, options?: CopyOptions): Promise<SobjMetadata>

📋 Parameters ​

ParameterTypeDescription
sourcestringSource key
destinationstringDestination key
optionsCopyOptionsCopy options

📦 Returns ​

SobjMetadata — metadata of the copied object.

🔑 presign ​

Generate pre-signed URLs for GET and PUT operations.

ts
presign: {
  get(key: string, options?: PresignOptions): Promise<string>
  put(key: string, options?: PresignPutOptions): Promise<string>
}

⚡ presign.get ​

ts
presign.get(key: string, options?: PresignOptions): Promise<string>

⚡ presign.put ​

ts
presign.put(key: string, options?: PresignPutOptions): Promise<string>

📦 multipart ​

Multipart upload operations for large objects.

ts
multipart: {
  create(key: string, options?: CreateMultipartOptions): Promise<MultipartUpload>
  uploadPart(upload: MultipartUpload, partNumber: number, body: SobjBody): Promise<MultipartPart>
  complete(upload: MultipartUpload, parts: readonly MultipartPart[]): Promise<SobjMetadata>
  abort(upload: MultipartUpload): Promise<void>
}

🧪 Example ​

ts
const upload = await storage.multipart.create('large.bin')

const part1 = await storage.multipart.uploadPart(upload, 1, chunk1)
const part2 = await storage.multipart.uploadPart(upload, 2, chunk2)

const metadata = await storage.multipart.complete(upload, [part1, part2])

Part numbers must be between 1 and 10,000 and passed in order to complete.

🏷️ versioning ​

Object versioning operations.

ts
versioning: {
  list(key: string, options?: ListVersionsOptions): Promise<SobjVersions>
  get(key: string, version: string, options?: GetOptions): Promise<SobjObject | null>
  delete(key: string, version?: string): Promise<void>
}
  • Types — all input and output types
  • Errors — error classes thrown by operations