Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @jsvfs/types

JSVFS Types

The type library for jsvfs, providing TypeScript types and interfaces for the main module and for creating new adapters.

If you're looking to use jsvfs, it's best to start with @jsvfs/core.

This module implements types and interfaces that can be used for developing jsvfs itself and adapters.

Installation

Get it from npm:

npm install --save @jsvfs/types

Documentation

Complete documentation of jsvfs can be found at the jsvfs site.

Index

Type aliases

FolderType

FolderType: "folder" | "root"

Types that implement folder or "parent item" functionality.

ItemType

ItemType: "file" | FolderType | LinkType

The valid item types implemented by jsvfs.

LinkType

LinkType: "hardlink" | "softlink"

Types the indicate the link behavior.

SnapshotEntry

Types of entries which may be encountered during a snapshot.

Variables

Const JSON_SCHEMA

JSON_SCHEMA: { JournalEntry: { additionalProperties: boolean; properties: { id: { type: string[] }; level: { enum: string[]; type: string }; message: { type: string }; op: { enum: string[]; type: string } }; required: string[]; type: string } } = ...

Type declaration

  • JournalEntry: { additionalProperties: boolean; properties: { id: { type: string[] }; level: { enum: string[]; type: string }; message: { type: string }; op: { enum: string[]; type: string } }; required: string[]; type: string }
    • additionalProperties: boolean
    • properties: { id: { type: string[] }; level: { enum: string[]; type: string }; message: { type: string }; op: { enum: string[]; type: string } }
      • id: { type: string[] }
        • type: string[]
      • level: { enum: string[]; type: string }
        • enum: string[]
        • type: string
      • message: { type: string }
        • type: string
      • op: { enum: string[]; type: string }
        • enum: string[]
        • type: string
    • required: string[]
    • type: string

Generated using TypeDoc