Class Storage

Hierarchy

Storage

Index

Constructors

Properties

Methods

deleteFile getAppBucketUrl getFile getFileContents getFileSignedUnencrypted getFileUrl getGaiaAddress getUserAppFileUrl handleSignedEncryptedContents listFiles putFile

Constructors

constructor

new Storage(options: StorageOptions): Storage
Parameters
- options: StorageOptions
Returns Storage
- Defined in packages/storage/src/storage.ts:111

Properties

userSession

userSession: UserSession

Methods

deleteFile

deleteFile(path: string, options?: {
wasSigned?: boolean;
}): Promise<void>
Deletes the specified file from the app's data store.

Returns
Resolves when the file has been removed or rejects with an error.
Parameters
- path: string
  
  The path to the file to delete.
- Optional options: {
  wasSigned?: boolean;
  }
  
  Optional options object.
  - Optional wasSigned?: boolean
    
    Set to true if the file was originally signed in order for the corresponding signature file to also be deleted.
Returns Promise<void>
- Defined in packages/storage/src/storage.ts:620

getAppBucketUrl

getAppBucketUrl(gaiaHubUrl: string, appPrivateKey: string): Promise<string>
Get the app storage bucket URL

Returns
That resolves to the URL of the app index file or rejects if it fails
Parameters
- gaiaHubUrl: string
  
  the gaia hub URL
- appPrivateKey: string
  
  the app private key used to generate the app address
Returns Promise<string>
- Defined in packages/storage/src/storage.ts:667

getFile

getFile(path: string, options?: GetFileOptions): Promise<null | string | ArrayBuffer>
Retrieves the specified file from the app's data store.

Returns
that resolves to the raw data in the file or rejects with an error
Parameters
- path: string
  
  the path to the file to read
- Optional options: GetFileOptions
  
  a GetFileOptions object
Returns Promise<null | string | ArrayBuffer>
- Defined in packages/storage/src/storage.ts:124

getFileContents

getFileContents(path: string, app: string, username: undefined | string, zoneFileLookupURL: undefined | string, forceText: boolean, fetchFn?: FetchFn): Promise<null | string | ArrayBuffer>
Parameters
- path: string
- app: string
- username: undefined | string
- zoneFileLookupURL: undefined | string
- forceText: boolean
- fetchFn: FetchFn = ...
Returns Promise<null | string | ArrayBuffer>
- Defined in packages/storage/src/storage.ts:269

getFileSignedUnencrypted

getFileSignedUnencrypted(path: string, opt: GetFileOptions): Promise<null | string | ArrayBuffer>
Parameters
- path: string
- opt: GetFileOptions
Returns Promise<null | string | ArrayBuffer>
- Defined in packages/storage/src/storage.ts:312

getFileUrl

getFileUrl(path: string, options?: GetFileUrlOptions): Promise<string>
Get the URL for reading a file from an app's data store.

Returns
that resolves to the URL or rejects with an error
Parameters
- path: string
  
  the path to the file to read
- Optional options: GetFileUrlOptions
Returns Promise<string>
- Defined in packages/storage/src/storage.ts:241

getGaiaAddress

getGaiaAddress(app: string, username?: string, zoneFileLookupURL?: string): Promise<string>
Parameters
- app: string
- Optional username: string
- Optional zoneFileLookupURL: string
Returns Promise<string>
- Defined in packages/storage/src/storage.ts:214

getUserAppFileUrl

getUserAppFileUrl(path: string, username: string, appOrigin: string, zoneFileLookupURL?: string): Promise<undefined | string>
Fetch the public read URL of a user file for the specified app.

Returns
that resolves to the public read URL of the file or rejects with an error
Parameters
- path: string
  
  the path to the file to read
- username: string
  
  The Blockstack ID of the user to look up
- appOrigin: string
  
  The app origin
- Optional zoneFileLookupURL: string
  
  The URL to use for zonefile lookup. If falsey, this will use the blockstack.js's getNameInfo function instead.
Returns Promise<undefined | string>
- Defined in packages/storage/src/storage.ts:191

handleSignedEncryptedContents

handleSignedEncryptedContents(path: string, storedContents: string, app: string, privateKey?: string, username?: string, zoneFileLookupURL?: string): Promise<string | Uint8Array>
Parameters
- path: string
- storedContents: string
- app: string
- Optional privateKey: string
- Optional username: string
- Optional zoneFileLookupURL: string
Returns Promise<string | Uint8Array>
- Defined in packages/storage/src/storage.ts:388

listFiles

listFiles(callback: ((name: string) => boolean)): Promise<number>
List the set of files in this application's Gaia storage bucket.

Returns
that resolves to the number of files listed
Parameters
- callback: ((name: string) => boolean)
  
  a callback to invoke on each named file that returns true to continue the listing operation or false to end it. If the call is ended early by the callback, the last file is excluded. If an error occurs the entire call is rejected.
  - - (name: string): boolean
    - Parameters
      
      name: string
      
      Returns boolean
Returns Promise<number>
- Defined in packages/storage/src/storage.ts:772

putFile

putFile(path: string, content: string | Uint8Array | ArrayBufferView | Blob, options?: PutFileOptions): Promise<string>
Stores the data provided in the app's data store to to the file specified.

Returns
that resolves if the operation succeed and rejects if it failed
Parameters
- path: string
  
  the path to store the data in
- content: string | Uint8Array | ArrayBufferView | Blob
  
  the data to store in the file
- Optional options: PutFileOptions
  
  a PutFileOptions object
Returns Promise<string>
- Defined in packages/storage/src/storage.ts:454

Class Storage

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: StorageOptions

Returns Storage

Properties

userSession

Methods

deleteFile

Returns

Parameters

path: string

Optional options: { wasSigned?: boolean; }

Optional wasSigned?: boolean

Returns Promise<void>

getAppBucketUrl

Returns

Parameters

gaiaHubUrl: string

appPrivateKey: string

Returns Promise<string>

getFile

Returns

Parameters

path: string

Optional options: GetFileOptions

Returns Promise<null | string | ArrayBuffer>

getFileContents

Parameters

path: string

app: string

username: undefined | string

zoneFileLookupURL: undefined | string

forceText: boolean

fetchFn: FetchFn = ...

Returns Promise<null | string | ArrayBuffer>

getFileSignedUnencrypted

Parameters

path: string

opt: GetFileOptions

Returns Promise<null | string | ArrayBuffer>

getFileUrl

Returns

Parameters

path: string

Optional options: GetFileUrlOptions

Returns Promise<string>

getGaiaAddress

Parameters

app: string

Optional username: string

Optional zoneFileLookupURL: string

Returns Promise<string>

getUserAppFileUrl

Returns

Parameters

path: string

username: string

appOrigin: string

Optional zoneFileLookupURL: string

Returns Promise<undefined | string>

handleSignedEncryptedContents

Parameters

path: string

storedContents: string

app: string

Optional privateKey: string

Optional username: string

Optional zoneFileLookupURL: string

Returns Promise<string | Uint8Array>

listFiles

Returns

Parameters

callback: ((name: string) => boolean)

`Optional` options: {
wasSigned?: boolean;
}

`Optional` wasSigned?: boolean

`Optional` options: GetFileOptions

`Optional` options: GetFileUrlOptions

`Optional` username: string

`Optional` zoneFileLookupURL: string

`Optional` zoneFileLookupURL: string

`Optional` privateKey: string

`Optional` username: string

`Optional` zoneFileLookupURL: string

`Optional` options: PutFileOptions