S3FileSystem

Defined in: src/s3.ts:41

Extends

• CloudFS<_S3Error>

Constructors

Constructor

new S3FileSystem(client, bucketName, prefix?, cacheTTL?): S3FileSystem

Defined in: src/s3.ts:46

Parameters

client

S3

bucketName

string

prefix?

string = ''

cacheTTL?

number

Returns

S3FileSystem

Overrides

CloudFS<_S3Error>.constructor

Properties

_mountPoint?

protected optional _mountPoint?: string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:143

Internal

The last place this file system was mounted

Inherited from

CloudFS._mountPoint

---

_sync?

protected optional _sync?: FileSystem

Defined in: src/s3.ts:44

Internal

Overrides

CloudFS._sync

---

_uuid

protected _uuid: `${string}-${string}-${string}-${string}-${string}`

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:149

Internal

The UUID of the file system.

Inherited from

CloudFS._uuid

---

attributes

readonly attributes: ConstMap<FileSystemAttributes, keyof FileSystemAttributes, void | CaseFold | undefined> & Map<string, any>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:154

See

FileSystemAttributes

Inherited from

CloudFS.attributes

---

bucketName

protected bucketName: string

Defined in: src/s3.ts:48

---

cacheTTL

readonly cacheTTL: number = 3600

Defined in: src/cloudfs.ts:29

Inherited from

CloudFS.cacheTTL

---

client

protected client: S3

Defined in: src/s3.ts:47

---

convertError

protected convertError: (error, message?) => Exception

Defined in: src/cloudfs.ts:30

Parameters

error

_S3Error

message?

string

Returns

Exception

Inherited from

CloudFS.convertError

---

label?

optional label?: string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:138

Inherited from

CloudFS.label

---

name

readonly name: string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:137

The name for this file system. For example, tmpfs for an in memory one

Inherited from

CloudFS.name

---

partialCache

protected partialCache: Map<string, CacheEntry>

Defined in: src/cloudfs.ts:116

Inherited from

CloudFS.partialCache

---

prefix

protected prefix: string

Defined in: src/s3.ts:42

---

type

readonly type: number

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:132

A unique ID for this kind of file system. Currently unused internally, but could be used for partition tables or something

Inherited from

CloudFS.type

Accessors

uuid

Get Signature

get uuid(): `${string}-${string}-${string}-${string}-${string}`

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:150

Returns

`${string}-${string}-${string}-${string}-${string}`

Inherited from

CloudFS.uuid

Methods

_create()

protected _create(path, inode): Promise<void>

Defined in: src/s3.ts:125

Parameters

path

string

inode

Inode

Returns

Promise<void>

Overrides

CloudFS._create

---

_delete()

protected _delete(path): Promise<void>

Defined in: src/s3.ts:105

Parameters

path

string

Returns

Promise<void>

Overrides

CloudFS._delete

---

_move()

_move(from, to): Promise<void>

Defined in: src/s3.ts:113

Parameters

from

string

to

string

Returns

Promise<void>

Overrides

CloudFS._move

---

_read()

protected _read(path): Promise<Uint8Array<ArrayBufferLike>>

Defined in: src/s3.ts:140

Parameters

path

string

Returns

Promise<Uint8Array<ArrayBufferLike>>

Overrides

CloudFS._read

---

_stat()

_stat(path): Promise<Inode>

Defined in: src/s3.ts:68

Parameters

path

string

Returns

Promise<Inode>

Todo

Handle prefix

Overrides

CloudFS._stat

---

_touch()

protected _touch(path, inode): Promise<void>

Defined in: src/s3.ts:152

Parameters

path

string

inode

Partial<InodeLike>

Returns

Promise<void>

Overrides

CloudFS._touch

---

_write()

protected _write(path, data): Promise<void>

Defined in: src/s3.ts:166

Parameters

path

string

data

Uint8Array

Returns

Promise<void>

Overrides

CloudFS._write

---

createFile()

createFile(path, options): Promise<Inode>

Defined in: src/cloudfs.ts:58

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

Promise<Inode>

Inherited from

CloudFS.createFile

---

createFileSync()

abstract createFileSync(path, options): InodeLike

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:190

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

InodeLike

Inherited from

CloudFS.createFileSync

---

exists()

exists(path): Promise<boolean>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:202

Test whether or not path exists.

Parameters

path

string

Returns

Promise<boolean>

Inherited from

CloudFS.exists

---

existsSync()

existsSync(path): boolean

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:206

Test whether or not path exists.

Parameters

path

string

Returns

boolean

Inherited from

CloudFS.existsSync

---

getValidContents()

protected getValidContents(path, syscall): Promise<Uint8Array<ArrayBufferLike>>

Defined in: src/cloudfs.ts:118

Parameters

path

string

syscall

string

Returns

Promise<Uint8Array<ArrayBufferLike>>

Inherited from

CloudFS.getValidContents

---

link()

link(): Promise<void>

Defined in: src/cloudfs.ts:97

Returns

Promise<void>

Inherited from

CloudFS.link

---

linkSync()

abstract linkSync(target, link): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:208

Parameters

target

string

link

string

Returns

void

Inherited from

CloudFS.linkSync

---

mkdir()

mkdir(path, options): Promise<Inode>

Defined in: src/cloudfs.ts:79

Parameters

path

string

options

CreationOptions

Returns

Promise<Inode>

Inherited from

CloudFS.mkdir

---

mkdirSync()

abstract mkdirSync(path, options): InodeLike

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:196

Parameters

path

string

options

CreationOptions

Returns

InodeLike

Inherited from

CloudFS.mkdirSync

---

queueDone()

queueDone(): Promise<void>

Defined in: node_modules/@zenfs/core/dist/mixins/async.d.ts:22

Deprecated

Use `sync` instead

Returns

Promise<void>

Inherited from

CloudFS.queueDone

---

read()

read(path, buffer, offset, end): Promise<void>

Defined in: src/cloudfs.ts:103

Reads into a buffer

Parameters

path

string

buffer

Uint8Array

The buffer to read into. You must set the byteOffset and byteLength appropriately!

offset

number

end

number

The position in the file to stop reading

Returns

Promise<void>

Inherited from

CloudFS.read

---

readdir()

readdir(path): Promise<string[]>

Defined in: src/s3.ts:84

Parameters

path

string

Returns

Promise<string[]>

Overrides

CloudFS.readdir

---

readdirSync()

abstract readdirSync(path): string[]

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:198

Parameters

path

string

Returns

string[]

Inherited from

CloudFS.readdirSync

---

readSync()

abstract readSync(path, buffer, start, end): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:224

Reads into a buffer

Parameters

path

string

buffer

Uint8Array

The buffer to read into. You must set the byteOffset and byteLength appropriately!

start

number

The offset into the file to start reading from

end

number

The position in the file to stop reading

Returns

void

Inherited from

CloudFS.readSync

---

ready()

ready(): Promise<void>

Defined in: src/s3.ts:57

Returns

Promise<void>

Overrides

CloudFS.ready

---

readySync()

readySync(): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:174

Returns

void

Inherited from

CloudFS.readySync

---

rename()

rename(oldPath, newPath): Promise<void>

Defined in: src/cloudfs.ts:43

Parameters

oldPath

string

newPath

string

Returns

Promise<void>

Inherited from

CloudFS.rename

---

renameSync()

abstract renameSync(oldPath, newPath): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:176

Parameters

oldPath

string

newPath

string

Returns

void

Inherited from

CloudFS.renameSync

---

rmdir()

rmdir(path): Promise<void>

Defined in: src/cloudfs.ts:73

Parameters

path

string

Returns

Promise<void>

Inherited from

CloudFS.rmdir

---

rmdirSync()

abstract rmdirSync(path): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:194

Parameters

path

string

Returns

void

Inherited from

CloudFS.rmdirSync

---

stat()

stat(path): Promise<InodeLike<number>>

Defined in: src/cloudfs.ts:50

Parameters

path

string

Returns

Promise<InodeLike<number>>

Inherited from

CloudFS.stat

---

statSync()

abstract statSync(path): InodeLike

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:178

Parameters

path

string

Returns

InodeLike

Inherited from

CloudFS.statSync

---

streamRead()

streamRead(path, options): ReadableStream

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:241

Read a file using a stream.

Parameters

path

string

options

StreamOptions

Returns

ReadableStream

Inherited from

CloudFS.streamRead

---

streamWrite()

streamWrite(path, options): WritableStream

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:246

Write a file using stream.

Parameters

path

string

options

StreamOptions

Returns

WritableStream

Inherited from

CloudFS.streamWrite

---

sync()

sync(): Promise<void>

Defined in: src/cloudfs.ts:95

Returns

Promise<void>

Inherited from

CloudFS.sync

---

syncSync()

abstract syncSync(): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:210

Returns

void

Inherited from

CloudFS.syncSync

---

toString()

toString(): string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:166

Returns

string

Inherited from

CloudFS.toString

---

touch()

touch(path, metadata?): Promise<void>

Defined in: src/cloudfs.ts:91

Modify metadata.

Parameters

path

string

metadata?

Partial<InodeLike> = {}

Returns

Promise<void>

Inherited from

CloudFS.touch

---

touchSync()

abstract touchSync(path, metadata): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:182

Modify metadata.

Parameters

path

string

metadata

Partial<InodeLike>

Returns

void

Inherited from

CloudFS.touchSync

---

unlink()

unlink(path): Promise<void>

Defined in: src/cloudfs.ts:67

Parameters

path

string

Returns

Promise<void>

Inherited from

CloudFS.unlink

---

unlinkSync()

abstract unlinkSync(path): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:192

Parameters

path

string

Returns

void

Inherited from

CloudFS.unlinkSync

---

usage()

usage(): UsageInfo

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:172

Default implementation.

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

UsageInfo

Todo

Implement

Inherited from

CloudFS.usage

---

write()

write(path, data, offset?): Promise<void>

Defined in: src/cloudfs.ts:110

Writes a buffer to a file

Parameters

path

string

data

Uint8Array

offset?

number = 0

The offset in the file to start writing

Returns

Promise<void>

Inherited from

CloudFS.write

---

writeSync()

abstract writeSync(path, buffer, offset): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:236

Writes a buffer to a file

Parameters

path

string

buffer

Uint8Array

The buffer to write. You must set the byteOffset and byteLength appropriately!

offset

number

The offset in the file to start writing

Returns

void

Inherited from

CloudFS.writeSync