Class LocalStorageAdapter

Hierarchy (View Summary)

BaseStorageAdapter
- LocalStorageAdapter

Index

Constructors

Properties

Methods

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

Constructors

constructor

new LocalStorageAdapter(config: StorageConfig): LocalStorageAdapter
Parameters
- config: StorageConfig
Returns LocalStorageAdapter
Overrides BaseStorageAdapter.constructor
- Defined in packages/storage-kit/src/adapters/local.ts:15

Properties

`Protected`connected

connected: boolean = false

Methods

connect

connect(): Promise<void>
Returns Promise<void>
Overrides BaseStorageAdapter.connect
- Defined in packages/storage-kit/src/adapters/local.ts:20

copy

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

delete

delete(filePath: string): Promise<void>
Parameters
- filePath: string
Returns Promise<void>
Overrides BaseStorageAdapter.delete
- Defined in packages/storage-kit/src/adapters/local.ts:91

disconnect

disconnect(): Promise<void>
Returns Promise<void>
Overrides BaseStorageAdapter.disconnect
- Defined in packages/storage-kit/src/adapters/local.ts:25

`Protected`ensureConnected

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

exists

exists(filePath: string): Promise<boolean>
Parameters
- filePath: string
Returns Promise<boolean>
Overrides BaseStorageAdapter.exists
- Defined in packages/storage-kit/src/adapters/local.ts:102

`Protected`generateFileName

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

get

get(filePath: string): Promise<Uint8Array<ArrayBufferLike> | null>
Parameters
- filePath: string
Returns Promise<Uint8Array<ArrayBufferLike> | null>
Overrides BaseStorageAdapter.get
- Defined in packages/storage-kit/src/adapters/local.ts:66

`Protected`getMimeType

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

getStream

getStream(filePath: string): Promise<ReadableStream<any> | null>
Parameters
- filePath: string
Returns Promise<ReadableStream<any> | null>
Overrides BaseStorageAdapter.getStream
- Defined in packages/storage-kit/src/adapters/local.ts:78

isConnected

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

isDirectory

isDirectory(filePath: string): Promise<boolean>
Parameters
- filePath: string
Returns Promise<boolean>
Overrides BaseStorageAdapter.isDirectory
- Defined in packages/storage-kit/src/adapters/local.ts:118

list

list(prefix?: string): Promise<StorageFile[]>
Parameters
- Optionalprefix: string
Returns Promise<StorageFile[]>
Overrides BaseStorageAdapter.list
- Defined in packages/storage-kit/src/adapters/local.ts:134

move

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

put

put(
    filePath: string,
    data: Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>,
    options?: PutOptions,
): Promise<StorageFile>
Parameters
- filePath: string
- data: Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>
- Optionaloptions: PutOptions
Returns Promise<StorageFile>
Overrides BaseStorageAdapter.put
- Defined in packages/storage-kit/src/adapters/local.ts:39

`Protected`sanitizePath

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

url

url(
    filePath: string,
    _expiresIn?: number,
    _options?: UrlOptions,
): Promise<string>
A path under /storage/, which the app serves itself: with the headers of contentTypeFor() and dispositionFor() (plus nosniff), not the type a static server infers from the extension (options are ignored).
Parameters
- filePath: string
- Optional_expiresIn: number
- Optional_options: UrlOptions
Returns Promise<string>
Overrides BaseStorageAdapter.url
- Defined in packages/storage-kit/src/adapters/local.ts:173

Class LocalStorageAdapter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LocalStorageAdapter

Properties

Protectedconnected

Methods

connect

Returns Promise<void>

copy

Parameters

Returns Promise<void>

delete

Parameters

Returns Promise<void>

disconnect

Returns Promise<void>

ProtectedensureConnected

Returns void

exists

Parameters

Returns Promise<boolean>

ProtectedgenerateFileName

Parameters

Returns string

get

Parameters

Returns Promise<Uint8Array<ArrayBufferLike> | null>

ProtectedgetMimeType

Parameters

Returns string

getStream

Parameters

Returns Promise<ReadableStream<any> | null>

isConnected

Returns boolean

isDirectory

Parameters

Returns Promise<boolean>

list

Parameters

Returns Promise<StorageFile[]>

move

Parameters

Returns Promise<void>

put

Parameters

Returns Promise<StorageFile>

ProtectedsanitizePath

Parameters

Returns string

url

Parameters

Returns Promise<string>

Settings

On This Page

`Protected`connected

`Protected`ensureConnected

`Protected`generateFileName

`Protected`getMimeType

`Protected`sanitizePath