Space SDK Package

Space SDK Package

  • Users
  • Storage
  • Space Docs

›User Storage Methods

User Storage Methods

  • UserStorage.createFolder() method
  • UserStorage.listDirectory() method
  • UserStorage.addItems() method
  • UserStorage.openFile() method

Types

  • UserStorageConfig interface
  • CreateFolderRequest interface
  • ListDirectoryRequest interface
  • ListDirectoryResponse interface
  • AddItemsRequest interface
  • AddItemsResponse interface
  • AddItemsStatus interface
  • AddItemsResultSummary interface
  • OpenFileRequest interface
  • OpenFileResponse interface

@spacehq/sdk > UserStorage > addItems

UserStorage.addItems() method

addItems is used to upload files to buckets.

It uses an ReadableStream of Uint8Array data to read each files content to be uploaded.

Uploads will sequential and asynchronous with updates being delivered through the event emitter returned by the function.

Signature:

addItems(request: AddItemsRequest): Promise<AddItemsResponse>;

Parameters

ParameterTypeDescription
requestAddItemsRequest

Returns:

Promise<AddItemsResponse>

Example

const spaceStorage = new UserStorage(spaceUser);

const response = await spaceStorage.addItems({
  bucket: 'personal',
  files: [
    {
      path: 'file.txt',
      content: '',
      mimeType: 'plain/text',
    },
    {
      path: 'space.png',
      content: '',
      mimeType: 'image/png',
    }
  ],
});

response.on('data', (data: AddItemsEventData) => {
 const status = data as AddItemsStatus;
 // update event on how each file is uploaded
});

response.on('error', (err: AddItemsEventData) => {
 const status = data as AddItemsStatus;
 // error event if a file upload fails
 // status.error contains the error
});

response.once('done', (data: AddItemsEventData) => {
 const summary = data as AddItemsResultSummary;
 // returns a summary of all files and their upload status
});

← UserStorage.listDirectory() methodUserStorage.openFile() method →
  • UserStorage.addItems() method
  • Parameters
  • Example
Space SDK Package
Docs
Getting StartedUsersStorage
Resources
All DocumentationProject SlackBlog
More
GitHubStar
Follow @spacestorage