FileHandle.ts overview

Identity brands and schemas for open file and directory handles.

Since v0.6.0

models

SeekMode (type alias)

The origin of a seek.

Signature

export type SeekMode = "start" | "end" | "current" | "data" | "hole"

Source

Since v0.6.0

schemas

SeekMode

Schema for the origin of a seek: the file start, the current position, the end, or the next data or hole region.

Signature

declare const SeekMode: Schema.Literals<readonly ["start", "current", "end", "data", "hole"]>

Source

Since v0.6.0

type IDs

DirectoryHandleId

Brand key that marks an open directory handle.

Signature

declare const DirectoryHandleId: unique symbol

Source

Since v0.6.0

DirectoryHandleId (type alias)

Brand key that marks an open directory handle.

Signature

export type DirectoryHandleId = typeof DirectoryHandleId

Source

Since v0.6.0

FileHandleId

Brand key that marks an open file handle.

Signature

declare const FileHandleId: unique symbol

Source

Since v0.6.0

FileHandleId (type alias)

Brand key that marks an open file handle.

Signature

export type FileHandleId = typeof FileHandleId

Source

Since v0.6.0