Interface MFS

The MFS interface allows working with files and directories in a mutable file system.

interface MFS {
    cat(
        path: string,
        options?: Partial<CatOptions>,
    ): AsyncIterable<Uint8Array<ArrayBufferLike>>;
    chmod(
        path: string,
        mode: number,
        options?: Partial<ChmodOptions>,
    ): Promise<void>;
    cp(
        source: string | CID<unknown, number, number, Version>,
        destination: string,
        options?: Partial<CpOptions>,
    ): Promise<void>;
    ls(path?: string, options?: Partial<LsOptions>): AsyncIterable<UnixFSEntry>;
    mkdir(path: string, options?: Partial<MkdirOptions>): Promise<void>;
    rm(path: string, options?: Partial<RmOptions>): Promise<void>;
    stat(
        path: string,
        options?: StatOptions,
    ): Promise<FileStats | DirectoryStats | RawStats>;
    stat(
        path: string,
        options?: ExtendedStatOptions,
    ): Promise<ExtendedFileStats | ExtendedDirectoryStats | ExtendedRawStats>;
    touch(path: string, options?: Partial<TouchOptions>): Promise<void>;
    writeBytes(
        bytes: Uint8Array,
        path: string,
        options?: Partial<WriteOptions>,
    ): Promise<void>;
    writeByteStream(
        bytes: ByteStream,
        path: string,
        options?: Partial<WriteOptions>,
    ): Promise<void>;
}

Index

Methods

cat chmod cp ls mkdir rm stat touch writeBytes writeByteStream

Methods

cat

cat(
path: string,
options?: Partial<CatOptions>,
): AsyncIterable<Uint8Array<ArrayBufferLike>>
Retrieve the contents of a file from your MFS.
Parameters
- path: string
- Optionaloptions: Partial<CatOptions>
Returns AsyncIterable<Uint8Array<ArrayBufferLike>>
Example
```
for await (const buf of fs.cat('/foo.txt')) {
  console.info(buf)
}
```
- Defined in packages/mfs/src/index.ts:125

chmod

chmod(
    path: string,
    mode: number,
    options?: Partial<ChmodOptions>,
): Promise<void>
Change the permissions on a file or directory in your MFS
Parameters
- path: string
- mode: number
- Optionaloptions: Partial<ChmodOptions>
Returns Promise<void>
Example
```
await fs.writeBytes(Uint8Array.from([0, 1, 2, 3]), '/foo.txt')
const beforeStats = await fs.stat('/foo.txt')

await fs.chmod('/foo.txt', 0x755)
const afterStats = await fs.stat('/foo.txt')

console.info(beforeStats)
console.info(afterStats)
```
- Defined in packages/mfs/src/index.ts:143

cp

cp(
    source: string | CID<unknown, number, number, Version>,
    destination: string,
    options?: Partial<CpOptions>,
): Promise<void>
Add a file or directory to a target directory in your MFS.
Parameters
- source: string | CID<unknown, number, number, Version>
- destination: string
- Optionaloptions: Partial<CpOptions>
Returns Promise<void>
Example
```
await fs.writeBytes(Uint8Array.from([0, 1, 2, 3]), '/foo.txt')
await fs.mkdir('/bar')

await fs.cp('/foo.txt', '/bar')
```
Copy a file from one place to another in your MFS.
Example
```
await fs.writeBytes(Uint8Array.from([0, 1, 2, 3]), '/foo.txt')

await fs.cp('/foo.txt', '/bar.txt')
```
- Defined in packages/mfs/src/index.ts:167

ls

ls(path?: string, options?: Partial<LsOptions>): AsyncIterable<UnixFSEntry>
List directory contents from your MFS.
Parameters
- Optionalpath: string
- Optionaloptions: Partial<LsOptions>
Returns AsyncIterable<UnixFSEntry>
Example
```
for await (const entry of fs.ls('/bar')) {
  console.info(entry)
}
```
- Defined in packages/mfs/src/index.ts:180

mkdir

mkdir(path: string, options?: Partial<MkdirOptions>): Promise<void>
Make a new directory in your MFS.
Parameters
- path: string
- Optionaloptions: Partial<MkdirOptions>
Returns Promise<void>
Example
```
await fs.mkdir('/new-dir')
```
- Defined in packages/mfs/src/index.ts:191

rm

rm(path: string, options?: Partial<RmOptions>): Promise<void>
Remove a file or directory from your MFS.
Parameters
- path: string
- Optionaloptions: Partial<RmOptions>
Returns Promise<void>
Example
```
await fs.mkdir('/new-dir')
await fs.rm('/new-dir')
```
- Defined in packages/mfs/src/index.ts:203

stat

stat(
path: string,
options?: StatOptions,
): Promise<FileStats | DirectoryStats | RawStats>
Return statistics about a UnixFS DAG in your MFS.
Parameters
- path: string
- Optionaloptions: StatOptions
Returns Promise<FileStats | DirectoryStats | RawStats>
Example
```
await fs.writeBytes(Uint8Array.from([0, 1, 2, 3]), '/foo.txt')

const stats = await fs.stat('/foo.txt')
console.info(stats)
```
- Defined in packages/mfs/src/index.ts:217
stat(
path: string,
options?: ExtendedStatOptions,
): Promise<ExtendedFileStats | ExtendedDirectoryStats | ExtendedRawStats>
Parameters
- path: string
- Optionaloptions: ExtendedStatOptions
Returns Promise<ExtendedFileStats | ExtendedDirectoryStats | ExtendedRawStats>
- Defined in packages/mfs/src/index.ts:218

touch

touch(path: string, options?: Partial<TouchOptions>): Promise<void>

Update the mtime of a UnixFS DAG in your MFS.

Parameters

path: string
Optionaloptions: Partial<TouchOptions>

Returns Promise<void>

Example

await fs.writeBytes(Uint8Array.from([0, 1, 2, 3]), '/foo.txt')
const beforeStats = await fs.stat('/foo.txt')

await fs.touch('/foo.txt')
const afterStats = await fs.stat(afterCid)

console.info(beforeStats)
console.info(afterStats)

writeBytes

writeBytes(
    bytes: Uint8Array,
    path: string,
    options?: Partial<WriteOptions>,
): Promise<void>
Add a single Uint8Array to your MFS as a file.
Parameters
- bytes: Uint8Array
- path: string
- Optionaloptions: Partial<WriteOptions>
Returns Promise<void>
Example
```
await fs.writeBytes(Uint8Array.from([0, 1, 2, 3]), '/foo.txt')
```
- Defined in packages/mfs/src/index.ts:98

writeByteStream

writeByteStream(
    bytes: ByteStream,
    path: string,
    options?: Partial<WriteOptions>,
): Promise<void>
Add a stream of Uint8Array to your MFS as a file.
Parameters
- bytes: ByteStream
- path: string
- Optionaloptions: Partial<WriteOptions>
Returns Promise<void>
Example
```
import fs from 'node:fs'

const stream = fs.createReadStream('./foo.txt')
await fs.writeByteStream(stream, '/foo.txt')
```
- Defined in packages/mfs/src/index.ts:112

Interface MFS

Index

Methods

Methods

cat

Parameters

Returns AsyncIterable<Uint8Array<ArrayBufferLike>>

Example

chmod

Parameters

Returns Promise<void>

Example

cp

Parameters

Returns Promise<void>

Example

Example

ls

Parameters

Returns AsyncIterable<UnixFSEntry>

Example

mkdir

Parameters

Returns Promise<void>

Example

rm

Parameters

Returns Promise<void>

Example

stat

Parameters

Returns Promise<FileStats | DirectoryStats | RawStats>

Example

Parameters

Returns Promise<ExtendedFileStats | ExtendedDirectoryStats | ExtendedRawStats>

touch

Parameters

Returns Promise<void>

Example

writeBytes

Parameters

Returns Promise<void>

Example

writeByteStream

Parameters

Returns Promise<void>

Example

Settings

On This Page