Errors

All errors thrown by Sobj are instances of SobjError or one of its subclasses.

📥 Import

import {
  SobjError,
  SobjNotFoundError,
  SobjPermissionError,
  SobjConflictError,
  SobjInvalidRequestError,
  SobjNetworkError,
  isSobjError,
} from 'sobj/errors'

🪹 SobjError

Base error class. All Sobj errors extend this.

class SobjError extends Error {
  readonly code: SobjErrorCode
  readonly status?: number
  readonly requestId?: string
}

📋 Properties

Property	Type	Description
`code`	`SobjErrorCode`	Error code
`status`	`number \| undefined`	HTTP status code, if applicable
`requestId`	`string \| undefined`	Request ID from the provider, if available
`message`	`string`	Error message
`cause`	`unknown`	Original error, if wrapped

📋 SobjErrorCode

type SobjErrorCode =
  | 'NOT_FOUND'
  | 'PERMISSION_DENIED'
  | 'CONFLICT'
  | 'INVALID_REQUEST'
  | 'NETWORK_ERROR'
  | 'UNKNOWN'

🔍 SobjNotFoundError

Thrown when an object does not exist.

class SobjNotFoundError extends SobjError {
  // code: 'NOT_FOUND'
}

Note: get and head return null instead of throwing SobjNotFoundError. This error is thrown in other contexts (e.g. when a copy source is missing).

🔐 SobjPermissionError

Thrown when the request is rejected due to insufficient permissions.

class SobjPermissionError extends SobjError {
  // code: 'PERMISSION_DENIED'
}

💥 SobjConflictError

Thrown when an operation conflicts with the current state of an object (e.g. conditional write failure).

class SobjConflictError extends SobjError {
  // code: 'CONFLICT'
}

🧩 SobjInvalidRequestError

Thrown when the request is malformed or uses invalid parameters.

class SobjInvalidRequestError extends SobjError {
  // code: 'INVALID_REQUEST'
}

🌐 SobjNetworkError

Thrown when the underlying network request fails (before a response is received).

class SobjNetworkError extends SobjError {
  // code: 'NETWORK_ERROR'
}

👮 isSobjError

Type guard that checks whether a value is a SobjError.

function isSobjError(error: unknown): error is SobjError

🧪 Example

import { isSobjError, SobjNotFoundError } from 'sobj/errors'

try {
  await storage.copy('missing.txt', 'dest.txt')
} catch (error) {
  if (error instanceof SobjNotFoundError) {
    console.log('Source object not found')
  } else if (isSobjError(error)) {
    console.log('Storage error:', error.code, error.status)
  } else {
    throw error
  }
}

⚙️ Error handling patterns

🛡️ Null-safe operations

get and head return null when an object does not exist, so they rarely throw:

const object = await storage.get('file.txt')

if (object === null) {
  // doesn't exist
}

🎯 Catching specific errors

import {
  SobjPermissionError,
  SobjNetworkError,
  isSobjError,
} from 'sobj/errors'

try {
  await storage.put('file.txt', body)
} catch (error) {
  if (error instanceof SobjPermissionError) {
    // handle auth failure
  } else if (error instanceof SobjNetworkError) {
    // handle connectivity problem
  } else if (isSobjError(error)) {
    // handle other Sobj errors
    console.log(error.code, error.message)
  } else {
    throw error
  }
}

Errors ​

📥 Import ​

🪹 SobjError ​

📋 Properties ​

📋 SobjErrorCode ​

🔍 SobjNotFoundError ​

🔐 SobjPermissionError ​

💥 SobjConflictError ​

🧩 SobjInvalidRequestError ​

🌐 SobjNetworkError ​

👮 isSobjError ​

🧪 Example ​

⚙️ Error handling patterns ​

🛡️ Null-safe operations ​

🎯 Catching specific errors ​