Class ChrisIO

Index

Constructors

Accessors

Methods

client_get dummy_upload file_deleteById file_download file_downloadStream file_moveById file_size file_upload folder_create folder_deleteByPath folder_moveByPath init storageProvider_set uploadLocalPath

Constructors

constructor

new ChrisIO(): ChrisIO
Returns ChrisIO
- Defined in packages/cumin/src/io/chrisIO.ts:88

Accessors

chrisFolder

get chrisFolder(): string
Returns string
- Defined in packages/cumin/src/io/chrisIO.ts:111
set chrisFolder(folder: string): void
Parameters
- folder: string
Returns void
- Defined in packages/cumin/src/io/chrisIO.ts:115

Methods

client_get

client_get(): Promise<Client | null>
Gets the ChRIS client instance, initializing it if necessary.

Returns Promise<Client | null>
A Promise resolving to the Client instance or null.
- Defined in packages/cumin/src/io/chrisIO.ts:104

dummy_upload

dummy_upload(): Promise<boolean | null>
Performs a dummy upload for testing purposes.

Returns Promise<boolean | null>
A Promise resolving to true on success, or null if client is missing.
- Defined in packages/cumin/src/io/chrisIO.ts:760

file_deleteById

file_deleteById(fileId: number): Promise<Result<boolean>>
Deletes one file by its id, without listing anything.

A file that cannot be LISTED must still be deletable: a folder whose listing the server refuses is exactly the folder an operator most needs to clear, and a delete that resolves its id through the parent's collection cannot help there (#462).
Parameters
- fileId: number
  The file's id.
Returns Promise<Result<boolean>>
Ok(true) when the file is gone, Err when the server refused.
- Defined in packages/cumin/src/io/chrisIO.ts:467

file_download

file_download(fileId: number): Promise<Buffer<ArrayBufferLike> | null>
Downloads a file from ChRIS by its ID.
Parameters
- fileId: number
  The ID of the file to download.
Returns Promise<Buffer<ArrayBufferLike> | null>
A Promise resolving to a Buffer of the file content, or null on failure.
- Defined in packages/cumin/src/io/chrisIO.ts:328

file_downloadStream

file_downloadStream(
fileId: number,
): Promise<Result<{ filename?: string; size?: number; stream: unknown }>>
Parameters
- fileId: number
Returns Promise<Result<{ filename?: string; size?: number; stream: unknown }>>
- Defined in packages/cumin/src/io/chrisIO.ts:250

file_moveById

file_moveById(fileId: number, destPath: string): Promise<Result<boolean>>
Moves (renames) a file in ChRIS by updating its path.
Parameters
- fileId: number
  The file ID.
- destPath: string
  The target path including filename.
Returns Promise<Result<boolean>>
Promise resolving to true on success, false on failure.
- Defined in packages/cumin/src/io/chrisIO.ts:658

file_size

file_size(fileId: number): Promise<number | null>
A file's size as CUBE records it, without reading its bytes.
Parameters
- fileId: number
  The file's id.
Returns Promise<number | null>
The size in bytes, or null when the file cannot be read or CUBE gives none.
- Defined in packages/cumin/src/io/chrisIO.ts:311

file_upload

file_upload(
    fileBlob: Blob,
    uploadDir: string,
    filename: string,
): Promise<boolean>
Uploads a file to ChRIS.
Parameters
- fileBlob: Blob
  The file content as a Blob.
- uploadDir: string
  The directory path in ChRIS to upload to.
- filename: string
  The name of the file to create.
Returns Promise<boolean>
A Promise resolving to true on success, false on failure.
- Defined in packages/cumin/src/io/chrisIO.ts:383

folder_create

folder_create(folderPath: string): Promise<Result<boolean>>
Creates a new folder in ChRIS at the specified path.
Parameters
- folderPath: string
  The path where the folder should be created.
Returns Promise<Result<boolean>>
A Result containing true if created, false if already exists, or Err on error.
Example
```
const result = await chrisIO.folder_create('/uploads/data');
if (result.ok && result.value) {
  console.log('Folder created successfully');
}
```
- Defined in packages/cumin/src/io/chrisIO.ts:532

folder_deleteByPath

folder_deleteByPath(
path: string,
options?: { timeoutMs?: number },
): Promise<Result<boolean>>
Deletes a folder (and its contents) addressed by path, waiting until the CUBE confirms it is gone.

Deletion is asynchronous server-side (the DELETE is only accepted), so success is defined as the path no longer resolving within the timeout.
Parameters
- path: string
  The folder's CUBE path (leading slash optional).
- options: { timeoutMs?: number } = {}
  timeoutMs bounds the disappearance poll (default 10s).
Returns Promise<Result<boolean>>
Ok(true) when the folder is verifiably gone (or never existed), Err on failure or timeout.
- Defined in packages/cumin/src/io/chrisIO.ts:621

folder_moveByPath

folder_moveByPath(srcPath: string, destPath: string): Promise<Result<boolean>>
Moves (renames) a folder in ChRIS by updating its path.
Parameters
- srcPath: string
  The current folder path.
- destPath: string
  The new folder path.
Returns Promise<Result<boolean>>
Promise resolving to true on success, false on failure.
- Defined in packages/cumin/src/io/chrisIO.ts:586

init

init(): Promise<boolean | null>
Initializes the ChrisIO instance by creating a file browser folder.

Returns Promise<boolean | null>
A Promise resolving to true on success, false on failure, or null if client is missing.
- Defined in packages/cumin/src/io/chrisIO.ts:123

storageProvider_set

storageProvider_set(provider: IStorageProvider): void
Sets the storage provider for local IO operations.
Parameters
- provider: IStorageProvider
  The storage provider instance.
Returns void
- Defined in packages/cumin/src/io/chrisIO.ts:96

uploadLocalPath

uploadLocalPath(localPath: string, remotePath: string): Promise<boolean>
Uploads a local directory or file to ChRIS recursively.
Parameters
- localPath: string
  The path on the local filesystem.
- remotePath: string
  The destination path on ChRIS. For directories, follows Unix cp semantics: the source directory name is appended to remotePath.
Returns Promise<boolean>
Promise success status.
- Defined in packages/cumin/src/io/chrisIO.ts:694

Class ChrisIO

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns ChrisIO

Accessors

chrisFolder

Returns string

Parameters

Returns void

Methods

client_get

Returns Promise<Client | null>

dummy_upload

Returns Promise<boolean | null>

file_deleteById

Parameters

Returns Promise<Result<boolean>>

file_download

Parameters

Returns Promise<Buffer<ArrayBufferLike> | null>

file_downloadStream

Parameters

Returns Promise<Result<{ filename?: string; size?: number; stream: unknown }>>

file_moveById

Parameters

Returns Promise<Result<boolean>>

file_size

Parameters

Returns Promise<number | null>

file_upload

Parameters

Returns Promise<boolean>

folder_create

Parameters

Returns Promise<Result<boolean>>

Example

folder_deleteByPath

Parameters

Returns Promise<Result<boolean>>

folder_moveByPath

Parameters

Returns Promise<Result<boolean>>

init

Returns Promise<boolean | null>

storageProvider_set

Parameters

Returns void

uploadLocalPath

Parameters

Returns Promise<boolean>

Settings

On This Page