@catalogworks/filebase-storage-js v0.1.6

Filebase Storage JS

seems familiar... Filebase Storage Js is an SDK to interact with Filebase Storage.

Methods

get

The get method is for fetching individual files, either the content or related data, such as the key, hash and publicUrl.

Example of usage:

const myFile = await filebaseStorage.get({
  apiKey: 'my-key',
  apiSecret: 'my-secret',
  key: 'my-file-key',
  getOptions: [
    'data',
    'bucket',
    'key',
    'hash',
    'publicUrl'
  ],
})

Input parameters of get

upload

The upload method uploads a file, identified by a key, to a bucket. The function returns the hash of the file, the publicUrl, the key and the bucket.

Example of usage:

fs.readFile(filePath, async (error, fileData) => {
  const uploadedFile = await filebaseStorage.upload({
    apiKey: 'my-key',
    apiSecret: 'my-secret',
    key: 'my-file-key',
    data: fileData,
  });
})

Input parameters of upload

deleteFile

The deleteFile method deletes a file, identified by its key and bucket. The function returns the key and bucket of the deleted file if successful. If the file does not exist, the method will still execute successfully.

Example of usage:

  await filebaseStorage.deleteFile({
    apiKey: 'my-key',
    apiSecret: 'my-secret',
    key: 'my-file-key',
    bucket: 'my-bucket',
  });

Input parameters of deleteFile

listFiles

The listFiles method is for fetching information about all files in a bucket such as the key, hash and publicUrl.

Example of usage:

const files = await filebaseStorage.listFiles({
  apiKey: 'my-key',
  apiSecret: 'my-secret',
  prefix: 'my-folder',
  getOptions: [
    'bucket',
    'key',
    'hash',
    'publicUrl'
  ],
})

Input parameters of listFiles

listBuckets

The listBuckets method returns an array of bucket names associated with the api key's account.

Example of usage:

const buckets = await filebaseStorage.listBuckets({
  apiKey: 'my-key',
  apiSecret: 'my-secret',
})

Input parameters of listBuckets

getFileFromHash

getFileFromHash is a utility function that downloads a file's data from Filebase's IPFS gateway using the hash. The key and secret is not required since the gateway is publicly available.

Example of usage:

const myFile = await filebaseStorage.getFileFromHash({
  hash: 'bafybeige4bhzjvrptn7fdz7mqgigzoczcliqpuo7km4jm7vgjg2pbmuhna',
  getFileFromHashOptions: [
    'buffer',
  ],
})

Input parameters of getFileFromHash