@squarecloud/blob
TypeScript icon, indicating that this package has built-in type declarations

0.1.0 • Public • Published
Square Cloud Banner

@squarecloud/blob

Official Square Cloud Blob SDK for NodeJS.

Installation

npm install @squarecloud/blob
// or
yarn add @squarecloud/blob
// or
pnpm add @squarecloud/blob

Documentation

Visit our official API documentation for more information about how this service.

Getting Started

import { SquareCloudBlob } from "@squarecloud/blob"
// const { SquareCloudBlob } = require("@squarecloud/blob");

const blob = new SquareCloudBlob("Your API Key")
const objects = await blob.objects.list()

Creating an object

const object = await blob.objects.put({ file: "path/to/file.png", name: "my_image" })
console.log(object.url)

Deleting objects

const objectsToDelete = ["ID/prefix/name1_xxx-xxx.zip", "ID/prefix/name_xxx-xxx-xxx.png"]
await blob.objects.delete(objectsToDelete)

Contributing

Feel free to contribute with suggestions or bug reports at our GitHub repository.

Authors

Package Sidebar

Install

npm i @squarecloud/blob

Weekly Downloads

2

Version

0.1.0

License

MIT

Unpacked Size

225 kB

Total Files

106

Last publish

Collaborators

  • richaardev
  • joaotonaco
  • joaootavios