`nupp.io.files.messages`

Module contents

Types

Type	Kind	Description
`Capabilities`	record	The exact filesystem guarantees supplied by one provider.
`Entry`	record	One immediate child of a listed directory.
`Info`	record	Metadata about one resolved filesystem object.
`Kind`	type
`Mode`	type
`Origin`	type
`TemporaryOptions`	record	Naming and placement options for a native temporary path.
`UserFolder`	type

Types#

`Capabilities`record#

record Capabilities ...

The exact filesystem guarantees supplied by one provider.

Members

Name	Kind	Description
`available`	field	Whether filesystem access is available at all.
`arbitraryPaths`	field	Whether ordinary native paths are accepted.
`symbolicLinks`	field	Whether symbolic links can be queried and created.
`readOnlyAttributes`	field	Whether read-only attributes can be changed.
`glob`	field	Whether filesystem globbing is supported.
`rename`	field	Whether paths can be renamed.
`atomicWrite`	field	Whether atomic replacement writes are supported.
`temporaryPaths`	field	Whether temporary path owners can be created.
`concurrentOpenHandles`	field	Whether one path may have multiple open handles.
`currentDirectory`	field	Whether a process working directory exists.
`userFolders`	field	Whether conventional user folders can be resolved.
`executableDirectory`	field	Whether the running executable's directory can be resolved.
`persistentStorageRequest`	field	Whether persistent browser storage can be requested.

`available`field#

available: boolean

Whether filesystem access is available at all.

`arbitraryPaths`field#

arbitraryPaths: boolean

Whether ordinary native paths are accepted.

`symbolicLinks`field#

symbolicLinks: boolean

Whether symbolic links can be queried and created.

`readOnlyAttributes`field#

readOnlyAttributes: boolean

Whether read-only attributes can be changed.

`glob`field#

glob: boolean

Whether filesystem globbing is supported.

`rename`field#

rename: boolean

Whether paths can be renamed.

`atomicWrite`field#

atomicWrite: boolean

Whether atomic replacement writes are supported.

`temporaryPaths`field#

temporaryPaths: boolean

Whether temporary path owners can be created.

`concurrentOpenHandles`field#

concurrentOpenHandles: boolean

Whether one path may have multiple open handles.

`currentDirectory`field#

currentDirectory: boolean

Whether a process working directory exists.

`userFolders`field#

userFolders: boolean

Whether conventional user folders can be resolved.

`executableDirectory`field#

executableDirectory: boolean

Whether the running executable's directory can be resolved.

`persistentStorageRequest`field#

persistentStorageRequest: boolean

Whether persistent browser storage can be requested.

`Entry`record#

record Entry ...

One immediate child of a listed directory.

Members

Name	Kind	Description
`name`	field	The child's name relative to the listed directory.
`kind`	field	The child's kind without following a symbolic link.

`name`field#

name: string

The child's name relative to the listed directory.

`kind`field#

kind: Kind

The child's kind without following a symbolic link.

`Info`record#

record Info ...

Metadata about one resolved filesystem object.

Members

Name	Kind	Description
`kind`	field	The object's filesystem kind.
`size`	field	Its byte size, or zero for a directory.
`modified`	field	Its modification time in milliseconds since the Unix epoch, the unit nupp.time.wallTime answers in, with whatever...
`readOnly`	field	Whether the native platform refuses writes.

`kind`field#

kind: Kind

The object's filesystem kind.

`size`field#

size: integer

Its byte size, or zero for a directory.

`modified`field#

modified: number

Its modification time in milliseconds since the Unix epoch, the unit nupp.time.wallTime answers in, with whatever fraction the platform records.

`readOnly`field#

readOnly: boolean

Whether the native platform refuses writes.

`Kind`type#

type Kind = "file" | "directory" | "symlink" | "other"

`Mode`type#

type Mode = "r" | "w" | "a" | "r+" | "w+" | "a+"

`Origin`type#

type Origin = "set" | "current" | "end"

`TemporaryOptions`record#

record TemporaryOptions ...

Naming and placement options for a native temporary path.

Members

Name	Kind	Description
`directory`	field	The native directory to create the path in.
`prefix`	field	A separator-free fragment placed before the random portion of the name.
`suffix`	field	A separator-free fragment placed after the random portion of the name.

`directory`field#

directory: (string | paths.Path)?

The native directory to create the path in.

`prefix`field#

prefix: string?

A separator-free fragment placed before the random portion of the name.

`suffix`field#

suffix: string?

A separator-free fragment placed after the random portion of the name.

`UserFolder`type#

type UserFolder = "home" | "documents" | "downloads" | "desktop" | "pictures" | "music" | "videos"

nupp.io.files.messages

Module contents

Types

Types#

Capabilitiesrecord#

Members

availablefield#

arbitraryPathsfield#

symbolicLinksfield#

readOnlyAttributesfield#

globfield#

renamefield#

atomicWritefield#

temporaryPathsfield#

concurrentOpenHandlesfield#

currentDirectoryfield#

userFoldersfield#

executableDirectoryfield#

persistentStorageRequestfield#

Entryrecord#

Members

namefield#

kindfield#

Inforecord#

Members

kindfield#

sizefield#

modifiedfield#

readOnlyfield#

Kindtype#

Modetype#

Origintype#

TemporaryOptionsrecord#

Members

directoryfield#

prefixfield#

suffixfield#

UserFoldertype#

`nupp.io.files.messages`

`Capabilities`record#

`available`field#

`arbitraryPaths`field#

`symbolicLinks`field#

`readOnlyAttributes`field#

`glob`field#

`rename`field#

`atomicWrite`field#

`temporaryPaths`field#

`concurrentOpenHandles`field#

`currentDirectory`field#

`userFolders`field#

`executableDirectory`field#

`persistentStorageRequest`field#

`Entry`record#

`name`field#

`kind`field#

`Info`record#

`kind`field#

`size`field#

`modified`field#

`readOnly`field#

`Kind`type#

`Mode`type#

`Origin`type#

`TemporaryOptions`record#

`directory`field#

`prefix`field#

`suffix`field#

`UserFolder`type#