File System Types

Since 1.8.0

Type-level file system operations.

Path Types

Path

Path type definition.

import type { Path } from 'uni-types'

type MyPath = Path<'/src/index.ts'>

RelativePath

Relative path type.

import type { RelativePath } from 'uni-types'

type Rel = RelativePath<'./src/index.ts'>  // './src/index.ts'
type Invalid = RelativePath<'/absolute'>  // never

AbsolutePath

Absolute path type.

import type { AbsolutePath } from 'uni-types'

type Abs = AbsolutePath<'/src/index.ts'>  // '/src/index.ts'

ParsePath

Parse path into components.

import type { ParsePath } from 'uni-types'

type Parts = ParsePath<'/src/index.ts'>
// { dirname: '/src'; basename: 'index.ts'; extname: '.ts' }

JoinPath

Join two paths.

import type { JoinPath } from 'uni-types'

type Joined = JoinPath<'/src', 'index.ts'>  // '/src/index.ts'

File Types

File

File definition.

import type { File } from 'uni-types'

type MyFile = File<'/src/index.ts'>

FileContent

File content types.

import type { FileContent } from 'uni-types'

type Content = FileContent  // string | ArrayBuffer | Buffer | Blob | ...

FileType

File type enumeration.

import type { FileType } from 'uni-types'

type Type = FileType  // 'file' | 'directory' | 'symlink' | 'socket' | ...

FilePermission

File permission types.

import type { FilePermission } from 'uni-types'

type Perm = FilePermission  // 'read' | 'write' | 'execute' | 'delete' | ...

Directory Types

Directory

Directory definition.

import type { Directory } from 'uni-types'

type Dir = Directory<'/src'>

DirectoryEntry

Directory entry type.

import type { DirectoryEntry } from 'uni-types'

type Entry = DirectoryEntry<string>

DirectoryTree

Directory tree structure.

import type { DirectoryTree } from 'uni-types'

type Tree = DirectoryTree<string>

GlobPattern

Glob pattern type.

import type { GlobPattern, CommonGlob } from 'uni-types'

type Pattern = GlobPattern  // string
type Common = CommonGlob  // '*.ts' | '**/*.js' | ...

Watch Types

FileWatch

File watch definition.

import type { FileWatch } from 'uni-types'

type Watch = FileWatch<string>

WatchEvent

Watch event types.

import type { WatchEvent } from 'uni-types'

type Event = WatchEvent  // 'create' | 'modify' | 'delete' | 'rename' | ...

Virtual File System

VirtualFS

Virtual file system definition.

import type { VirtualFS } from 'uni-types'

type VFS = VirtualFS<string>

VFSNode

VFS node type.

import type { VFSNode } from 'uni-types'

type Node = VFSNode<string>

Archive Types

Archive

Archive definition.

import type { Archive } from 'uni-types'

type Zip = Archive<string>

ArchiveFormat

Archive format types.

import type { ArchiveFormat } from 'uni-types'

type Format = ArchiveFormat  // 'zip' | 'tar' | 'gz' | 'bz2' | '7z' | ...

File Metadata

FileMetadata

File metadata definition.

import type { FileMetadata } from 'uni-types'

type Meta = FileMetadata<string>

FileHash

File hash definition.

import type { FileHash } from 'uni-types'

type Hash = FileHash
// { algorithm: 'md5' | 'sha1' | 'sha256' | ...; value: string }