InternalStorageClass | amplify-js

Provide storage methods to use AWS S3

Hierarchy

InternalStorageClass
- Storage

Index

Constructors

constructor

Methods

Constructors

constructor

new InternalStorageClass(): InternalStorageClass

- Defined in packages/storage/src/internals/InternalStorage.ts:56
Initialize Storage

Returns InternalStorageClass

Methods

addPluggable

addPluggable(pluggable: StorageProvider): object

- Defined in packages/storage/src/internals/InternalStorage.ts:82
add plugin into Storage category

Parameters
- pluggable: StorageProvider
  
  an instance of the plugin
Returns object

cancel

cancel(request: Promise<any> | UploadTask, message?: string, customUserAgentDetails?: CustomUserAgentDetails): void | Promise<boolean>

- Defined in packages/storage/src/internals/InternalStorage.ts:213
Cancels an inflight request

Parameters
- request: Promise<any> | UploadTask
  
  The request to cancel
- Optional message: string
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns void | Promise<boolean>

configure

configure(config?: any): any

- Defined in packages/storage/src/internals/InternalStorage.ts:123
Configure Storage

Parameters
- Optional config: any
  
  Configuration object for storage
Returns any
- Current configuration

copy

copy<T>(src: StorageCopySource, dest: StorageCopyDestination, config?: StorageCopyConfig<T>, customUserAgentDetails?: CustomUserAgentDetails): StorageCopyOutput<T>

- Defined in packages/storage/src/internals/InternalStorage.ts:243
Copies a file from src to dest.

Type parameters
- T: Record<string, any>
Parameters
- src: StorageCopySource
  
  The source object.
- dest: StorageCopyDestination
  
  The destination object.
- Optional config: StorageCopyConfig<T>
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns StorageCopyOutput<T>

A promise resolves to the copied object's key.

get

get<T>(key: string, config?: StorageGetConfig<T>, customUserAgentDetails?: CustomUserAgentDetails): StorageGetOutput<T>

- Defined in packages/storage/src/internals/InternalStorage.ts:292
Get a presigned URL of the file or the object data when download:true

Type parameters
- T: Record<string, any> & object
Parameters
- key: string
  
  key of the object
- Optional config: StorageGetConfig<T>
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns StorageGetOutput<T>
- A promise resolves to either a presigned url or the object

getModuleName

getModuleName(): string

- Defined in packages/storage/src/internals/InternalStorage.ts:74
Returns string

getPluggable

getPluggable(providerName: string): StorageProvider

- Defined in packages/storage/src/internals/InternalStorage.ts:97
Get the plugin object

Parameters
- providerName: string
  
  the name of the plugin
Returns StorageProvider

getProperties

getProperties<T>(key: string, config?: StorageGetPropertiesConfig<T>, customUserAgentDetails?: CustomUserAgentDetails): StorageGetPropertiesOutput<T>

- Defined in packages/storage/src/internals/InternalStorage.ts:331
Type parameters
- T: StorageProvider | object
Parameters
- key: string
- Optional config: StorageGetPropertiesConfig<T>
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns StorageGetPropertiesOutput<T>

isCancelError

isCancelError(error: any): boolean

- Defined in packages/storage/src/internals/InternalStorage.ts:327
Parameters
- error: any
Returns boolean

list

list<T>(key: string, config?: StorageListConfig<T>, customUserAgentDetails?: CustomUserAgentDetails): StorageListOutput<T>

- Defined in packages/storage/src/internals/InternalStorage.ts:447
List bucket objects relative to the level and prefix specified

Type parameters
- T: Record<string, any>
Parameters
- key: string
- Optional config: StorageListConfig<T>
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns StorageListOutput<T>
- Promise resolves to list of keys for all objects in path

put

put<T>(key: string, object: any, config?: StoragePutConfig<T>, customUserAgentDetails?: CustomUserAgentDetails): StoragePutOutput<T>

- Defined in packages/storage/src/internals/InternalStorage.ts:370
Put a file in storage bucket specified to configure method

Type parameters
- T: Record<string, any>
Parameters
- key: string
  
  key of the object
- object: any
  
  File to be put in bucket
- Optional config: StoragePutConfig<T>
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns StoragePutOutput<T>
- promise resolves to object on success

remove

remove<T>(key: string, config?: StorageRemoveConfig<T>, customUserAgentDetails?: CustomUserAgentDetails): StorageRemoveOutput<T>

- Defined in packages/storage/src/internals/InternalStorage.ts:414
Remove the object for specified key

Type parameters
- T: Record<string, any>
Parameters
- key: string
  
  key of the object
- Optional config: StorageRemoveConfig<T>
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns StorageRemoveOutput<T>
- Promise resolves upon successful removal of the object

removePluggable

removePluggable(providerName: string): void

- Defined in packages/storage/src/internals/InternalStorage.ts:111
Remove the plugin object

Parameters
- providerName: string
  
  the name of the plugin
Returns void