// Copy object `copy-object-test` from `copy-object-test-pass-src` to `copy-object-test-pass-dest`
// TIP: Set bucket on constructor, it will be used as the default source for copying objects.
await objectManager.copy(`copy-object-test`, `copy-object-dest`, {
sourceBucket: `copy-object-src`
diff --git a/global.html b/global.html
index 2fb4faf..e32195d 100644
--- a/global.html
+++ b/global.html
@@ -1,3 +1,3 @@
Global
Type Definitions bucket Properties Name Type Description Name
string The name of the bucket
Date
date the bucket was created
gateway 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
gatewayOptions 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
name 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
nameOptions Properties Name Type Attributes Description enabled
boolean <optional> Whether the name is enabled or not.
objectManagerOptions Optional settings for the constructor.
Optional settings for the constructor.
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.
objectDownloadOptions Optional settings for downloading objects
.
Optional settings for downloading objects
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
objectOptions Properties Name Type Attributes Description bucket
string <optional> The bucket to pin the IPFS CID into.
objectHeadResult 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> <optional> 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
listObjectsResult 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
listObjectOptions 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.
copyObjectOptions 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.
pinManagerOptions Optional settings for the constructor.
Optional settings for the constructor.
Properties Name Type Attributes Description bucket
string <optional> Default bucket to use.
gateway
pinDownloadOptions <optional> Default gateway to use.
pinDownloadOptions Optional settings for downloading pins
.
Optional settings for downloading pins
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
pinStatus 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> Optional info for PinStatus response
download
function Convenience function to download pin
pinOptions Properties Name Type Attributes Description bucket
string <optional> The bucket to pin the IPFS CID into.
listPinOptions 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
listPinResults Properties Name Type Description count
number Total number of pin objects that exist for passed query filters
Array
Array.<pinStatus > of PinStatus results
replacePinOptions 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
\ No newline at end of file
+
Type Definitions bucket Properties Name Type Description Name
string The name of the bucket
Date
date the bucket was created
gateway 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
gatewayOptions 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
name 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
nameOptions Properties Name Type Attributes Description enabled
boolean <optional> Whether the name is enabled or not.
objectManagerOptions Optional settings for the constructor.
Optional settings for the constructor.
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.
objectDownloadOptions Optional settings for downloading objects
.
Optional settings for downloading objects
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
objectOptions Properties Name Type Attributes Description bucket
string <optional> The bucket to pin the IPFS CID into.
objectHeadResult 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> <optional> 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
listObjectsResult 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
listObjectOptions 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.
copyObjectOptions 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.
pinManagerOptions Optional settings for the constructor.
Optional settings for the constructor.
Properties Name Type Attributes Description bucket
string <optional> Default bucket to use.
gateway
pinDownloadOptions <optional> Default gateway to use.
pinDownloadOptions Optional settings for downloading pins
.
Optional settings for downloading pins
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
pinStatus 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> Optional info for PinStatus response
download
function Convenience function to download pin
pinOptions Properties Name Type Attributes Description bucket
string <optional> The bucket to pin the IPFS CID into.
listPinOptions 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
listPinResults Properties Name Type Description count
number Total number of pin objects that exist for passed query filters
Array
Array.<pinStatus > of PinStatus results
replacePinOptions 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