Fleek 存储 Js

Fleek存储 Js是一个与Fleek存储器交互的SDK.

: exclaim: 请不要在浏览器中直接使用此软件包. 您的 API 秘密将被该页面的用户看到 。 如果您需要客户端提出请求,请直接使用带有预签名的urls的S3 SDK: https://docs.aws.amazon.com/AmazonsS3/latest/userguide/using-presigned-url.html 互联网档案馆的存檔,存档日期2013-12-21。 。 。 .

yarn add @fleekhq/fleek-storage-js

导入

SDK可以使用 import 语句.

import fleekStorage from '@fleekhq/fleek-storage-js'

SDK也可以使用 require。 。 。 .

const fleekStorage = require('@fleekhq/fleek-storage-js')

获取 Api 密钥

Api 密钥和密钥可以生成于 Fleek 网络应用程序 或从 闪光 CLI。 。 。 .

见 获取 Api 密钥

方法

起来

这个 get 方法是获取单个文件,无论是内容还是相关数据,如密钥、散列和公用Url.

使用实例:

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

获取输入参数

上传

这个 upload 方法上传一个文件,由密钥识别,到一桶. 函数返回文件的散列, publicUrl, 键和桶 .

使用实例:

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

上传的输入参数

删除文件

这个 deleteFile 方法删除文件,由文件的密钥和桶识别. 函数返回已删除文件的密钥和桶, 如果成功 . 如果文件不存在, 方法仍将成功执行 .

使用实例:

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

删除的输入参数

列表文件

这个 listFiles 方法就是在密钥、散列和公用Url等桶中获取所有文件的信息.

使用实例:

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

列表的输入参数

列表按钮

这个 listBuckets 方法返回与 api 密钥账户相关的桶名.

使用实例:

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

列表的输入参数

从哈什获取文件

getFileFromHash 是一个使用散列从 Fleek 的 IPFS 网关下载文件数据的工具函数。 由于网关是公开的,所以不需要钥匙和秘密.

使用实例:

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

获取FileFromHash 的输入参数