Class S3FileSystem

Hierarchy

CloudFS<_S3Error>
- S3FileSystem

Constructors

constructor

new S3FileSystem(
    client: S3,
    bucketName: string,
    prefix?: string,
    cacheTTL?: number,
): S3FileSystem
Parameters
- client: S3
- bucketName: string
- prefix: string = ''
- OptionalcacheTTL: number
Returns S3FileSystem
Overrides CloudFS<_S3Error>.constructor
- Defined in src/s3.ts:46

Properties

`Protected` `Optional` `Internal`_mountPoint

_mountPoint?: string

The last place this file system was mounted

`Protected` `Optional` `Internal`_sync

_sync?: FileSystem

`Protected` `Internal`_uuid

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

The UUID of the file system.

`Readonly`attributes

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

See

FileSystemAttributes

`Protected`bucketName

bucketName: string

`Readonly`cacheTTL

cacheTTL: number = 3600

`Protected`client

client: S3

`Protected`convertError

convertError: (error: _S3Error, message?: string) => Exception

`Optional`label

label?: string

`Readonly`name

name: string

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

`Protected`partialCache

partialCache: Map<string, CacheEntry> = ...

`Protected`prefix

prefix: string

`Readonly`type

type: number

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

Accessors

uuid

get uuid(): `${string}-${string}-${string}-${string}-${string}`
Returns `${string}-${string}-${string}-${string}-${string}`
Inherited from CloudFS.uuid
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:150

Methods

`Protected`_create

_create(path: string, inode: Inode): Promise<void>
Parameters
- path: string
- inode: Inode
Returns Promise<void>
Overrides CloudFS._create
- Defined in src/s3.ts:125

`Protected`_delete

_delete(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Overrides CloudFS._delete
- Defined in src/s3.ts:105

_move

_move(from: string, to: string): Promise<void>
Parameters
- from: string
- to: string
Returns Promise<void>
Overrides CloudFS._move
- Defined in src/s3.ts:113

`Protected`_read

_read(path: string): Promise<Uint8Array<ArrayBufferLike>>
Parameters
- path: string
Returns Promise<Uint8Array<ArrayBufferLike>>
Overrides CloudFS._read
- Defined in src/s3.ts:140

_stat

_stat(path: string): Promise<Inode>
Parameters
- path: string
Returns Promise<Inode>
Todo
Handle prefix
Overrides CloudFS._stat
- Defined in src/s3.ts:68

`Protected`_touch

_touch(path: string, inode: Partial<InodeLike>): Promise<void>
Parameters
- path: string
- inode: Partial<InodeLike>
Returns Promise<void>
Overrides CloudFS._touch
- Defined in src/s3.ts:152

`Protected`_write

_write(path: string, data: Uint8Array): Promise<void>
Parameters
- path: string
- data: Uint8Array
Returns Promise<void>
Overrides CloudFS._write
- Defined in src/s3.ts:166

createFile

createFile(path: string, options: CreationOptions): Promise<Inode>
Create the file at path with the given options.
Parameters
- path: string
- options: CreationOptions
Returns Promise<Inode>
Inherited from CloudFS.createFile
- Defined in src/cloudfs.ts:58

`Abstract`createFileSync

createFileSync(path: string, options: CreationOptions): InodeLike
Create the file at path with the given options.
Parameters
- path: string
- options: CreationOptions
Returns InodeLike
Inherited from CloudFS.createFileSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:189

exists

exists(path: string): Promise<boolean>
Test whether or not path exists.
Parameters
- path: string
Returns Promise<boolean>
Inherited from CloudFS.exists
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:201

existsSync

existsSync(path: string): boolean
Test whether or not path exists.
Parameters
- path: string
Returns boolean
Inherited from CloudFS.existsSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:205

`Protected`getValidContents

getValidContents(
path: string,
syscall: string,
): Promise<Uint8Array<ArrayBufferLike>>
Parameters
- path: string
- syscall: string
Returns Promise<Uint8Array<ArrayBufferLike>>
Inherited from CloudFS.getValidContents
- Defined in src/cloudfs.ts:118

link

link(): Promise<void>
Returns Promise<void>
Inherited from CloudFS.link
- Defined in src/cloudfs.ts:97

`Abstract`linkSync

linkSync(target: string, link: string): void
Parameters
- target: string
- link: string
Returns void
Inherited from CloudFS.linkSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:207

mkdir

mkdir(path: string, options: CreationOptions): Promise<Inode>
Parameters
- path: string
- options: CreationOptions
Returns Promise<Inode>
Inherited from CloudFS.mkdir
- Defined in src/cloudfs.ts:79

`Abstract`mkdirSync

mkdirSync(path: string, options: CreationOptions): InodeLike
Parameters
- path: string
- options: CreationOptions
Returns InodeLike
Inherited from CloudFS.mkdirSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:195

queueDone

queueDone(): Promise<void>
Returns Promise<void>
Deprecated
Use sync instead
Inherited from CloudFS.queueDone
- Defined in node_modules/@zenfs/core/dist/mixins/async.d.ts:22

read

read(
    path: string,
    buffer: Uint8Array,
    offset: number,
    end: number,
): Promise<void>
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
- Defined in src/cloudfs.ts:103

readdir

readdir(path: string): Promise<string[]>
Parameters
- path: string
Returns Promise<string[]>
Overrides CloudFS.readdir
- Defined in src/s3.ts:84

`Abstract`readdirSync

readdirSync(path: string): string[]
Parameters
- path: string
Returns string[]
Inherited from CloudFS.readdirSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:197

`Abstract`readSync

readSync(path: string, buffer: Uint8Array, start: number, end: number): void
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
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:223

ready

ready(): Promise<void>
Returns Promise<void>
Overrides CloudFS.ready
- Defined in src/s3.ts:57

rename

rename(oldPath: string, newPath: string): Promise<void>
Parameters
- oldPath: string
- newPath: string
Returns Promise<void>
Inherited from CloudFS.rename
- Defined in src/cloudfs.ts:43

`Abstract`renameSync

renameSync(oldPath: string, newPath: string): void
Parameters
- oldPath: string
- newPath: string
Returns void
Inherited from CloudFS.renameSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:175

rmdir

rmdir(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Inherited from CloudFS.rmdir
- Defined in src/cloudfs.ts:73

`Abstract`rmdirSync

rmdirSync(path: string): void
Parameters
- path: string
Returns void
Inherited from CloudFS.rmdirSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:193

stat

stat(path: string): Promise<InodeLike<number>>
Parameters
- path: string
Returns Promise<InodeLike<number>>
Inherited from CloudFS.stat
- Defined in src/cloudfs.ts:50

`Abstract`statSync

statSync(path: string): InodeLike
Parameters
- path: string
Returns InodeLike
Inherited from CloudFS.statSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:177

streamRead

streamRead(path: string, options: StreamOptions): ReadableStream
Read a file using a stream.
Parameters
- path: string
- options: StreamOptions
Returns ReadableStream
Inherited from CloudFS.streamRead
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:240

streamWrite

streamWrite(path: string, options: StreamOptions): WritableStream
Write a file using stream.
Parameters
- path: string
- options: StreamOptions
Returns WritableStream
Inherited from CloudFS.streamWrite
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:245

sync

sync(): Promise<void>
Returns Promise<void>
Inherited from CloudFS.sync
- Defined in src/cloudfs.ts:95

`Abstract`syncSync

syncSync(): void
Returns void
Inherited from CloudFS.syncSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:209

toString

toString(): string
Returns string
Inherited from CloudFS.toString
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:166

touch

touch(path: string, metadata?: Partial<InodeLike>): Promise<void>
Modify metadata.
Parameters
- path: string
- metadata: Partial<InodeLike> = {}
Returns Promise<void>
Inherited from CloudFS.touch
- Defined in src/cloudfs.ts:91

`Abstract`touchSync

touchSync(path: string, metadata: Partial<InodeLike>): void
Modify metadata.
Parameters
- path: string
- metadata: Partial<InodeLike>
Returns void
Inherited from CloudFS.touchSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:181

unlink

unlink(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Inherited from CloudFS.unlink
- Defined in src/cloudfs.ts:67

`Abstract`unlinkSync

unlinkSync(path: string): void
Parameters
- path: string
Returns void
Inherited from CloudFS.unlinkSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:191

usage

usage(): UsageInfo
Experimental
Default implementation.

Returns UsageInfo
Todo
Implement
Inherited from CloudFS.usage
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:172

write

write(path: string, data: Uint8Array, offset?: number): Promise<void>
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
- Defined in src/cloudfs.ts:110

`Abstract`writeSync

writeSync(path: string, buffer: Uint8Array, offset: number): void
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
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:235

Class S3FileSystem

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns S3FileSystem

Properties

Protected Optional Internal_mountPoint

Protected Optional Internal_sync

Protected Internal_uuid

Readonlyattributes

See

ProtectedbucketName

ReadonlycacheTTL

Protectedclient

ProtectedconvertError

Optionallabel

Readonlyname

ProtectedpartialCache

Protectedprefix

Readonlytype

Accessors

uuid

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

Methods

Protected_create

Parameters

Returns Promise<void>

Protected_delete

Parameters

Returns Promise<void>

_move

Parameters

Returns Promise<void>

Protected_read

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

_stat

Parameters

Returns Promise<Inode>

Todo

Protected_touch

Parameters

Returns Promise<void>

Protected_write

Parameters

Returns Promise<void>

createFile

Parameters

Returns Promise<Inode>

AbstractcreateFileSync

Parameters

Returns InodeLike

exists

Parameters

Returns Promise<boolean>

existsSync

Parameters

Returns boolean

ProtectedgetValidContents

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

link

Returns Promise<void>

AbstractlinkSync

Parameters

Returns void

mkdir

Parameters

Returns Promise<Inode>

AbstractmkdirSync

Parameters

Returns InodeLike

queueDone

Returns Promise<void>

`Protected` `Optional` `Internal`_mountPoint

`Protected` `Optional` `Internal`_sync

`Protected` `Internal`_uuid

`Readonly`attributes

`Protected`bucketName

`Readonly`cacheTTL

`Protected`client

`Protected`convertError

`Optional`label

`Readonly`name

`Protected`partialCache

`Protected`prefix

`Readonly`type

`Protected`_create

`Protected`_delete

`Protected`_read

`Protected`_touch

`Protected`_write

`Abstract`createFileSync

`Protected`getValidContents

`Abstract`linkSync

`Abstract`mkdirSync

`Abstract`readdirSync

`Abstract`readSync

`Abstract`renameSync

`Abstract`rmdirSync

`Abstract`statSync

`Abstract`syncSync

`Abstract`touchSync

`Abstract`unlinkSync

`Abstract`writeSync