Class NodeStorageProvider

NodeStorageProvider implements IStorageProvider using Node.js's native 'fs' module. It handles file system operations for reading, writing, and removing files, and creating directories.

Implements

IStorageProvider

Index

Constructors

Methods

basename exists isDirectory join mkdir read readBinary readdir remove write

Constructors

constructor

new NodeStorageProvider(): NodeStorageProvider

Returns NodeStorageProvider

Methods

basename

basename(filepath: string): string
Parameters
- filepath: string
Returns string
Implementation of IStorageProvider.basename
- Defined in packages/cumin/src/io/node_io.ts:165

exists

exists(filepath: string): Promise<boolean>
Parameters
- filepath: string
Returns Promise<boolean>
Implementation of IStorageProvider.exists
- Defined in packages/cumin/src/io/node_io.ts:114

isDirectory

isDirectory(filepath: string): Promise<boolean>
Parameters
- filepath: string
Returns Promise<boolean>
Implementation of IStorageProvider.isDirectory
- Defined in packages/cumin/src/io/node_io.ts:145

join

join(...paths: string[]): string
Parameters
- ...paths: string[]
Returns string
Implementation of IStorageProvider.join
- Defined in packages/cumin/src/io/node_io.ts:161

mkdir

mkdir(filepath: string, options?: { recursive?: boolean }): Promise<void>
Parameters
- filepath: string
- Optionaloptions: { recursive?: boolean }
Returns Promise<void>
Implementation of IStorageProvider.mkdir
- Defined in packages/cumin/src/io/node_io.ts:100

read

read(filepath: string): Promise<string | null>
Parameters
- filepath: string
Returns Promise<string | null>
Implementation of IStorageProvider.read
- Defined in packages/cumin/src/io/node_io.ts:41

readBinary

readBinary(filepath: string): Promise<ArrayBuffer | null>
Parameters
- filepath: string
Returns Promise<ArrayBuffer | null>
Implementation of IStorageProvider.readBinary
- Defined in packages/cumin/src/io/node_io.ts:57

readdir

readdir(filepath: string): Promise<string[]>
Parameters
- filepath: string
Returns Promise<string[]>
Implementation of IStorageProvider.readdir
- Defined in packages/cumin/src/io/node_io.ts:130

remove

remove(filepath: string): Promise<void>
Parameters
- filepath: string
Returns Promise<void>
Implementation of IStorageProvider.remove
- Defined in packages/cumin/src/io/node_io.ts:86

write

write(filepath: string, data: string): Promise<void>
Parameters
- filepath: string
- data: string
Returns Promise<void>
Implementation of IStorageProvider.write
- Defined in packages/cumin/src/io/node_io.ts:74