Hub JS Package

Hub JS Package

  • Users
  • Buckets
  • Threads
  • Textile Docs

@textile/hub > PushOptions

PushOptions interface

PushOptions provides additional options for controlling a push to a bucket path.

Signature:

export interface PushOptions 

Properties

PropertyTypeDescription
progress?(num?: number) => void(Optional) A callback function to use for monitoring push progress.
root?Root | string(Optional) The bucket root path as a string, or root object. Important to set this property when there is a possibility of multiple parallel pushes to a bucket. Specifying this property will enforce fast-forward only updates. It not provided explicitly, the root path will be fetched via an additional API call before each push.
signal?AbortSignal(Optional) An optional abort signal to allow cancellation or aborting a bucket push.
  • PushOptions interface
  • Properties
Hub JS Package
Docs
Getting StartedThreadDBBuckets
Resources
All DocumentationProject SlackBlog
More
GitHubStar
Follow @textileio