@textile/hub > Buckets > listPath
Buckets.listPath() method
Returns information about a bucket path.
Signature:
listPath(key: string, path: string, depth?: number): Promise<Path>;
Parameters
Parameter | Type | Description |
---|---|---|
key | string | Unique (IPNS compatible) identifier key for a bucket. |
path | string | A file/object (sub)-path within a bucket. |
depth | number | (optional) will walk the entire bucket to target depth (default = 1) |
Returns:
Promise<Path>