View as markdown

FileSystem

Experimental

Dependencies: Network, Storage

Commands

`FileSystem.getDirectory`

Parameters

Name	Type	Description
`bucketFileSystemLocator`	`BucketFileSystemLocator`

Return Object

Name	Type	Description
`directory`	`Directory`	Returns the directory object at the path.

Types

`File`

(object)

Properties

Name	Type	Description
`name`	`string`
`lastModified`	`Network.TimeSinceEpoch`	Timestamp
`size`	`number`	Size in bytes
`type`	`string`

`Directory`

(object)

Properties

Name	Type	Description
`name`	`string`
`nestedDirectories`	`array<string>`
`nestedFiles`	`array<File>`	Files that are directly nested under this directory.

`BucketFileSystemLocator`

(object)

Properties

Name	Type	Description
`storageKey`	`Storage.SerializedStorageKey`	Storage key
`bucketName` (optional)	`string`	Bucket name. Not passing a `bucketName` will retrieve the default Bucket. (https://developer.mozilla.org/en-US/docs/Web/API/Storage_API#storage_buckets)
`pathComponents`	`array<string>`	Path to the directory using each path component as an array item.

Summary