Class BaseStorageAdapter`Abstract`

Hierarchy (View Summary)

BaseStorageAdapter
- LocalStorageAdapter

Implements

StorageAdapter

Index

Constructors

Properties

Methods

connect copy delete disconnect ensureConnected exists generateFileName get getMimeType getStream isConnected isDirectory list move put sanitizePath url

Constructors

constructor

new BaseStorageAdapter(): BaseStorageAdapter

Returns BaseStorageAdapter

Properties

`Protected`connected

connected: boolean = false

Methods

`Abstract`connect

connect(): Promise<void>
Returns Promise<void>
Implementation of StorageAdapter.connect
- Defined in packages/storage-kit/src/base.ts:88

copy

copy(from: string, to: string): Promise<void>
Parameters
- from: string
- to: string
Returns Promise<void>
Implementation of StorageAdapter.copy
- Defined in packages/storage-kit/src/base.ts:109

`Abstract`delete

delete(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Implementation of StorageAdapter.delete
- Defined in packages/storage-kit/src/base.ts:93

`Abstract`disconnect

disconnect(): Promise<void>
Returns Promise<void>
Implementation of StorageAdapter.disconnect
- Defined in packages/storage-kit/src/base.ts:89

`Protected`ensureConnected

ensureConnected(): void
Returns void
- Defined in packages/storage-kit/src/base.ts:103

`Abstract`exists

exists(path: string): Promise<boolean>
Parameters
- path: string
Returns Promise<boolean>
Implementation of StorageAdapter.exists
- Defined in packages/storage-kit/src/base.ts:94

`Protected`generateFileName

generateFileName(originalName: string): string
Parameters
- originalName: string
Returns string
- Defined in packages/storage-kit/src/base.ts:129

`Abstract`get

get(path: string): Promise<Uint8Array<ArrayBufferLike> | null>
Parameters
- path: string
Returns Promise<Uint8Array<ArrayBufferLike> | null>
Implementation of StorageAdapter.get
- Defined in packages/storage-kit/src/base.ts:91

`Protected`getMimeType

getMimeType(filename: string): string
Parameters
- filename: string
Returns string
- Defined in packages/storage-kit/src/base.ts:142

`Abstract`getStream

getStream(path: string): Promise<ReadableStream<any> | null>
Parameters
- path: string
Returns Promise<ReadableStream<any> | null>
Implementation of StorageAdapter.getStream
- Defined in packages/storage-kit/src/base.ts:92

isConnected

isConnected(): boolean
Returns boolean
- Defined in packages/storage-kit/src/base.ts:99

`Abstract`isDirectory

isDirectory(path: string): Promise<boolean>
Parameters
- path: string
Returns Promise<boolean>
Implementation of StorageAdapter.isDirectory
- Defined in packages/storage-kit/src/base.ts:97

`Abstract`list

list(prefix?: string): Promise<StorageFile[]>
Parameters
- Optionalprefix: string
Returns Promise<StorageFile[]>
Implementation of StorageAdapter.list
- Defined in packages/storage-kit/src/base.ts:95

move

move(from: string, to: string): Promise<void>
Parameters
- from: string
- to: string
Returns Promise<void>
Implementation of StorageAdapter.move
- Defined in packages/storage-kit/src/base.ts:117

`Abstract`put

put(
    path: string,
    data:
        | Uint8Array<ArrayBufferLike>
        | Buffer<ArrayBufferLike>
        | ReadableStream<any>,
    options?: PutOptions,
): Promise<StorageFile>
Parameters
- path: string
- data: Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike> | ReadableStream<any>
- Optionaloptions: PutOptions
Returns Promise<StorageFile>
Implementation of StorageAdapter.put
- Defined in packages/storage-kit/src/base.ts:90

`Protected`sanitizePath

sanitizePath(path: string): string
Parameters
- path: string
Returns string
- Defined in packages/storage-kit/src/base.ts:136

`Abstract`url

url(path: string, expiresIn?: number, options?: UrlOptions): Promise<string>
Parameters
- path: string
- OptionalexpiresIn: number
- Optionaloptions: UrlOptions
Returns Promise<string>
Implementation of StorageAdapter.url
- Defined in packages/storage-kit/src/base.ts:96