Global

Type Definitions

bucket

Type:

Object

Properties

Name	Type	Description
`Name`	string	The name of the bucket
`Date`	date	the bucket was created

Source: bucketManager.js, line 43

gateway

Type:

Object

Properties

Name	Type	Description
`name`	string	Name for the gateway
`domain`	string	Custom Domain for the gateway
`enabled`	boolean	Whether the gateway is enabled or not
`private`	string	Whether the gateway is scoped to users content
`created_at`	date	Date the gateway was created
`updated_at`	date	Date the gateway was last updated

Source: gatewayManager.js, line 35

gatewayOptions

Type:

Object

Properties

Name	Type	Attributes	Description
`domain`	boolean	<optional>	Optional Domain to allow for using a Custom Domain
`enabled`	string	<optional>	Optional Toggle to use for enabling the gateway
`private`	boolean	<optional>	Optional Boolean determining if gateway is Public or Private

Source: gatewayManager.js, line 45

name

Type:

Object

Properties

Name	Type	Description
`label`	string	Descriptive label for the Key
`network_key`	string	IPNS Key CID
`cid`	string	Value that name Publishes
`sequence`	number	Version Number for the name
`enabled`	boolean	Whether the name is being Published or not
`published_at`	date	Date the name was last published to the DHT
`created_at`	date	Date the name was created
`updated_at`	date	Date the name was last updated

Source: nameManager.js, line 36

nameOptions

Type:

Object

Properties

Name	Type	Attributes	Description
`enabled`	boolean	<optional>	Whether the name is enabled or not.

Source: nameManager.js, line 48

objectManagerOptions

Optional settings for the constructor.

Type:

Object

Properties

Name	Type	Attributes	Description
`bucket`	string	<optional>	Default bucket to use.
`gateway`	objectDownloadOptions	<optional>	Default gateway to use.
`maxConcurrentUploads`	number	<optional>	The maximum number of concurrent uploads.

Source: objectManager.js, line 37

objectDownloadOptions

Optional settings for downloading objects

Type:

Object

Properties

Name	Type	Attributes	Default	Description
`endpoint`	string			Default gateway to use.
`token`	string	<optional>		Token for the default gateway.
`timeout`	number	<optional>	60000	Timeout for the default gateway

Source: objectManager.js, line 44

objectOptions

Type:

Object

Properties

Name	Type	Attributes	Description
`bucket`	string	<optional>	The bucket to pin the IPFS CID into.

Source: objectManager.js, line 98

objectHeadResult

Type:

Object

Properties

Name Type Attributes Description

cid

string

The CID of the uploaded object

download

function

Convenience function to download the object via S3 or the selected gateway

entries

array.<Object>

If a directory then returns an array of the containing objects

Properties

Name	Type	Description
`cid`	string	The CID of the uploaded object
`path`	string	The path of the object

Source: objectManager.js, line 103

listObjectsResult

Type:

Object

Properties

Name Type Description

IsTruncated

boolean

Indicates if more results exist on the server

NextContinuationToken

string

ContinuationToken used to paginate list requests

Contents

Array.<Object>

List of Keys stored in the S3 Bucket

Properties

Name	Type	Description
`Key`	string	Key of the Object
`LastModified`	string	Date Last Modified of the Object
`CID`	string	CID of the Object
`ETag`	string	ETag of the Object
`Size`	number	Size in Bytes of the Object
`StorageClass`	string	Class of Storage of the Object
`download`	function	Convenience function to download the item using the S3 gateway

Source: objectManager.js, line 470

listObjectOptions

Type:

Object

Properties

Name	Type	Attributes	Default	Description
`Bucket`	string	<optional>		The name of the bucket. If not provided, the default bucket will be used.
`ContinuationToken`	string	<optional>	null	Continues listing from this objects name.
`Delimiter`	string	<optional>	null	Character used to group keys
`MaxKeys`	number	<optional>	1000	The maximum number of objects to retrieve. Defaults to 1000.

Source: objectManager.js, line 484

copyObjectOptions

Type:

Object

Properties

Name	Type	Attributes	Description
`sourceBucket`	string	<optional>	The source bucket from where the object is to be copied.
`destinationKey`	string	<optional>	The key of the object in the destination bucket. By default, it is the same as the sourceKey.

Source: objectManager.js, line 549

pinManagerOptions

Optional settings for the constructor.

Type:

Object

Properties

Name	Type	Attributes	Description
`bucket`	string	<optional>	Default bucket to use.
`gateway`	pinDownloadOptions	<optional>	Default gateway to use.

Source: pinManager.js, line 14

pinDownloadOptions

Optional settings for downloading pins

Type:

Object

Properties

Name	Type	Attributes	Default	Description
`endpoint`	string			Default gateway to use.
`token`	string	<optional>		Token for the default gateway.
`timeout`	number	<optional>	60000	Timeout for the default gateway

Source: pinManager.js, line 20

pinStatus

Type:

Object

Properties

Name Type Attributes Description

requestid

string

Globally unique identifier of the pin request; can be used to check the status of ongoing pinning, or pin removal

status

string

Status a pin object can have at a pinning service. ("queued","pinning","pinned","failed")

created

string

Immutable timestamp indicating when a pin request entered a pinning service; can be used for filtering results and pagination

pin

Object

Pin object

Properties

Name	Type	Description
`cid`	string	Content Identifier (CID) pinned recursively
`name`	string	Name for pinned data; can be used for lookups later
`origins`	Array.<string>	Optional list of multiaddrs known to provide the data
`meta`	Object	Optional metadata for pin object

delegates

Array.<string>

List of multiaddrs designated by pinning service that will receive the pin data

info

object

Optional info for PinStatus response

download

function

Convenience function to download pin

Source: pinManager.js, line 66

pinOptions

Type:

Object

Properties

Name	Type	Attributes	Description
`bucket`	string	<optional>	The bucket to pin the IPFS CID into.

Source: pinManager.js, line 81

listPinOptions

Type:

Object

Properties

Name	Type	Attributes	Description
`cid`	Array.<string>	<optional>	Return pin objects responsible for pinning the specified CID(s); be aware that using longer hash functions introduces further constraints on the number of CIDs that will fit under the limit of 2000 characters per URL in browser contexts
`name`	string	<optional>	Return pin objects with specified name (by default a case-sensitive, exact match)
`match`	string	<optional>	Customize the text matching strategy applied when the name filter is present; exact (the default) is a case-sensitive exact match, partial matches anywhere in the name, iexact and ipartial are case-insensitive versions of the exact and partial strategies
`status`	Array.<string>	<optional>	Return pin objects for pins with the specified status (when missing, service defaults to pinned only)
`before`	string	<optional>	Return results created (queued) before provided timestamp
`after`	string	<optional>	Return results created (queued) after provided timestamp
`limit`	number	<optional>	Max records to return
`meta`	Object	<optional>	Return pin objects that match specified metadata keys passed as a string representation of a JSON object; when implementing a client library, make sure the parameter is URL-encoded to ensure safe transport

Source: pinManager.js, line 86

listPinResults

Type:

Object

Properties

Name	Type	Description
`count`	number	Total number of pin objects that exist for passed query filters
`Array`	Array.<pinStatus>	of PinStatus results

Source: pinManager.js, line 98

replacePinOptions

Type:

Object

Properties

Name	Type	Attributes	Description
`metadata`	Object	<optional>	Optional metadata to set on pin during replacement
`name`	string	<optional>	Optional name for pin to set during replacement

Source: pinManager.js, line 168