@fkn/lib/fs

Type Aliases

AdoptSummary

type AdoptSummary = object;

Properties

deleted

deleted: string[];

failed

failed: object[];

error

error: string;

path

path: string;

kept

kept: string[];

resolved

resolved: object[];

choice

choice: "local" | "cloud" | "merged";

path

path: string;

unresolved

unresolved: string[];

uploaded

uploaded: string[];

ConflictChoice

type ConflictChoice =
  | "local"
  | "cloud"
  | {
  merged: WriteData;
}
  | null;

ConflictResolver

type ConflictResolver = (conflict) =>
  | Promise<ConflictChoice>
  | ConflictChoice;

Parameters

conflict

FileConflict

Returns

| Promise<ConflictChoice> | ConflictChoice

ConflictSide

type ConflictSide = object;

Properties

size

size: number;

updatedAt

updatedAt: string | null;

FileConflict

type FileConflict = object;

Properties

cloud

cloud: ConflictSide;

local

local: ConflictSide;

path

path: string;

readCloud

readCloud: () => Promise<Blob>;

Returns

Promise<Blob>

readLocal

readLocal: () => Promise<Blob>;

Returns

Promise<Blob>

Stats

type Stats = object;

Properties

atimeMs

atimeMs: number;

ctimeMs

ctimeMs: number;

isDirectory

isDirectory: () => boolean;

Returns

boolean

isFile

isFile: () => boolean;

Returns

boolean

isSymbolicLink

isSymbolicLink: () => boolean;

Returns

boolean

mode

mode: number;

mtime

mtime: Date;

mtimeMs

mtimeMs: number;

size

size: number;

Variables

adopt

const adopt: () => Promise<AdoptSummary> = hybrid.adopt;

Returns

Promise<AdoptSummary>

adoptable

const adoptable: () => Promise<{
  bytes: number;
  paths: string[];
}> = hybrid.adoptable;

Returns

Promise<{ bytes: number; paths: string[]; }>

appendFile

appendFile: (path, data, a, b?) => void;

Parameters

path

PathLike

data

WriteData

a

WriteOptions | Callback<void>

b?

Callback<void>

Returns

void

appendFileSync

appendFileSync: (path, data, options?) => void;

Parameters

path

PathLike

data

WriteData

options?

WriteOptions

Returns

void

available

available: () => Promise<boolean>;

Returns

Promise<boolean>

default

default: object;

Type Declaration

adopt

adopt: () => Promise<AdoptSummary>;

Returns

Promise<AdoptSummary>

adoptable

adoptable: () => Promise<{
  bytes: number;
  paths: string[];
}>;

Returns

Promise<{ bytes: number; paths: string[]; }>

appendFile

appendFile: (path, data, a, b?) => void;

Parameters

path

PathLike

data

WriteData

a

WriteOptions | Callback<void>

b?

Callback<void>

Returns

void

appendFileSync

appendFileSync: (path, data, options?) => void;

Parameters

path

PathLike

data

WriteData

options?

WriteOptions

Returns

void

available

available: () => Promise<boolean> = backing.available;

Returns

Promise<boolean>

exists

exists: (path, callback) => void;

Parameters

path

PathLike

callback

(exists) => void

Returns

void

existsSync

existsSync: (path) => boolean;

Parameters

path

PathLike

Returns

boolean

flush

flush: () => Promise<void> = store.flush;

Returns

Promise<void>

lstatSync

lstatSync: (path) => Stats = statSync;

Parameters

path

PathLike

Returns

Stats

mkdir

mkdir: (path, a, b?) => void;

Parameters

path

PathLike

a

MakeOptions | Callback<void>

b?

Callback<void>

Returns

void

mkdirSync

mkdirSync: (path, options?) => void;

Parameters

path

PathLike

options?

MakeOptions

Returns

void

mount

mount: () => Promise<void> = store.mount;

Returns

Promise<void>

onConflict

onConflict: (next) => () => void;

Parameters

ConflictResolver

Returns

() => void

pending

pending: () => string[];

Returns

string[]

pendingDeletes

pendingDeletes: () => string[];

Returns

string[]

promises

promises: object;

promises.access

access: (path) => Promise<void>;

Parameters

path

PathLike

Returns

Promise<void>

promises.appendFile

appendFile: (path, data, options?) => Promise<void>;

Parameters

path

PathLike

data

WriteData

options?

WriteOptions

Returns

Promise<void>

promises.lstat

lstat: (path) => Promise<Stats>;

Parameters

path

PathLike

Returns

Promise<Stats>

promises.mkdir

mkdir: (path, options?) => Promise<void>;

Parameters

path

PathLike

options?

MakeOptions

Returns

Promise<void>

promises.readdir

readdir: (path) => Promise<string[]>;

Parameters

path

PathLike

Returns

Promise<string[]>

promises.readFile

readFile: (path, options?) => Promise<string | Buffer<ArrayBufferLike>>;

Parameters

path

PathLike

options?

ReadOptions

Returns

Promise<string | Buffer<ArrayBufferLike>>

promises.rename

rename: (from, to) => Promise<void>;

Parameters

from

PathLike

to

PathLike

Returns

Promise<void>

promises.rm

rm: (path, options?) => Promise<void>;

Parameters

path

PathLike

options?

force?

boolean

recursive?

boolean

Returns

Promise<void>

promises.rmdir

rmdir: (path, options?) => Promise<void>;

Parameters

path

PathLike

options?

recursive?

boolean

Returns

Promise<void>

promises.stat

stat: (path) => Promise<Stats>;

Parameters

path

PathLike

Returns

Promise<Stats>

promises.unlink

unlink: (path) => Promise<void>;

Parameters

path

PathLike

Returns

Promise<void>

promises.writeFile

writeFile: (path, data, options?) => Promise<void>;

Parameters

path

PathLike

data

WriteData

options?

WriteOptions

Returns

Promise<void>

pull

pull: (path) => Promise<Blob>;

Parameters

path

string

Returns

Promise<Blob>

readdir

readdir: (path, a, b?) => void;

Parameters

path

PathLike

a

unknown

b?

Callback<string[]>

Returns

void

readdirSync

readdirSync: (path) => string[];

Parameters

path

PathLike

Returns

string[]

readFile

readFile: (path, a, b?) => void;

Parameters

path

PathLike

a

ReadOptions | Callback<string | Buffer<ArrayBufferLike>>

b?

Callback<string | Buffer<ArrayBufferLike>>

Returns

void

readFileSync

readFileSync: (path, options?) => string | Buffer<ArrayBufferLike>;

Parameters

path

PathLike

options?

ReadOptions

Returns

string | Buffer<ArrayBufferLike>

remount

remount: () => Promise<void> = store.remount;

Returns

Promise<void>

rename

rename: (from, to, callback) => void;

Parameters

from

PathLike

to

PathLike

callback

Callback<void>

Returns

void

renameSync

renameSync: (from, to) => void;

Parameters

from

PathLike

to

PathLike

Returns

void

replicating

replicating: () => boolean;

Returns

boolean

rm

rm: (path, a, b?) => void;

Parameters

path

PathLike

a

| Callback<void> | { force?: boolean; recursive?: boolean; }

b?

Callback<void>

Returns

void

rmdirSync

rmdirSync: (path, options?) => void;

Parameters

path

PathLike

options?

recursive?

boolean

Returns

void

rmSync

rmSync: (path, options?) => void;

Parameters

path

PathLike

options?

force?

boolean

recursive?

boolean

Returns

void

stat

stat: (path, callback) => void;

Parameters

path

PathLike

callback

Callback<Stats>

Returns

void

statSync

statSync: (path) => Stats;

Parameters

path

PathLike

Returns

Stats

unlink

unlink: (path, callback) => void;

Parameters

path

PathLike

callback

Callback<void>

Returns

void

unlinkSync

unlinkSync: (path) => void;

Parameters

path

PathLike

Returns

void

writeFile

writeFile: (path, data, a, b?) => void;

Parameters

path

PathLike

data

WriteData

a

WriteOptions | Callback<void>

b?

Callback<void>

Returns

void

writeFileSync

writeFileSync: (path, data, options?) => void;

Parameters

path

PathLike

data

WriteData

options?

WriteOptions

Returns

void

exists

exists: (path, callback) => void;

Parameters

path

PathLike

callback

(exists) => void

Returns

void

existsSync

existsSync: (path) => boolean;

Parameters

path

PathLike

Returns

boolean

flush

flush: () => Promise<void>;

Returns

Promise<void>

lstatSync

lstatSync: (path) => Stats;

Parameters

path

PathLike

Returns

Stats

mkdir

mkdir: (path, a, b?) => void;

Parameters

path

PathLike

a

MakeOptions | Callback<void>

b?

Callback<void>

Returns

void

mkdirSync

mkdirSync: (path, options?) => void;

Parameters

path

PathLike

options?

MakeOptions

Returns

void

mount

mount: () => Promise<void>;

Returns

Promise<void>

onConflict

const onConflict: (next) => () => void = hybrid.onConflict;

Parameters

ConflictResolver

Returns

() => void

pending

const pending: () => string[] = hybrid.pending;

Returns

string[]

pendingDeletes

const pendingDeletes: () => string[] = hybrid.pendingDeletes;

Returns

string[]

promises

promises: object;

Type Declaration

access

access: (path) => Promise<void>;

Parameters

path

PathLike

Returns

Promise<void>

appendFile

appendFile: (path, data, options?) => Promise<void>;

Parameters

path

PathLike

data

WriteData

options?

WriteOptions

Returns

Promise<void>

lstat

lstat: (path) => Promise<Stats>;

Parameters

path

PathLike

Returns

Promise<Stats>

mkdir

mkdir: (path, options?) => Promise<void>;

Parameters

path

PathLike

options?

MakeOptions

Returns

Promise<void>

readdir

readdir: (path) => Promise<string[]>;

Parameters

path

PathLike

Returns

Promise<string[]>

readFile

readFile: (path, options?) => Promise<string | Buffer<ArrayBufferLike>>;

Parameters

path

PathLike

options?

ReadOptions

Returns

Promise<string | Buffer<ArrayBufferLike>>

rename

rename: (from, to) => Promise<void>;

Parameters

from

PathLike

to

PathLike

Returns

Promise<void>

rm

rm: (path, options?) => Promise<void>;

Parameters

path

PathLike

options?

force?

boolean

recursive?

boolean

Returns

Promise<void>

rmdir

rmdir: (path, options?) => Promise<void>;

Parameters

path

PathLike

options?

recursive?

boolean

Returns

Promise<void>

stat

stat: (path) => Promise<Stats>;

Parameters

path

PathLike

Returns

Promise<Stats>

unlink

unlink: (path) => Promise<void>;

Parameters

path

PathLike

Returns

Promise<void>

writeFile

writeFile: (path, data, options?) => Promise<void>;

Parameters

path

PathLike

data

WriteData

options?

WriteOptions

Returns

Promise<void>

pull

const pull: (path) => Promise<Blob> = hybrid.pull;

Parameters

path

string

Returns

Promise<Blob>

readdir

readdir: (path, a, b?) => void;

Parameters

path

PathLike

a

unknown

b?

Callback<string[]>

Returns

void

readdirSync

readdirSync: (path) => string[];

Parameters

path

PathLike

Returns

string[]

readFile

readFile: (path, a, b?) => void;

Parameters

path

PathLike

a

ReadOptions | Callback<string | Buffer<ArrayBufferLike>>

b?

Callback<string | Buffer<ArrayBufferLike>>

Returns

void

readFileSync

readFileSync: (path, options?) => string | Buffer<ArrayBufferLike>;

Parameters

path

PathLike

options?

ReadOptions

Returns

string | Buffer<ArrayBufferLike>

remount

remount: () => Promise<void>;

Returns

Promise<void>

rename

rename: (from, to, callback) => void;

Parameters

from

PathLike

to

PathLike

callback

Callback<void>

Returns

void

renameSync

renameSync: (from, to) => void;

Parameters

from

PathLike

to

PathLike

Returns

void

replicating

const replicating: () => boolean = hybrid.replicating;

Returns

boolean

rm

rm: (path, a, b?) => void;

Parameters

path

PathLike

a

| Callback<void> | { force?: boolean; recursive?: boolean; }

b?

Callback<void>

Returns

void

rmdirSync

rmdirSync: (path, options?) => void;

Parameters

path

PathLike

options?

recursive?

boolean

Returns

void

rmSync

rmSync: (path, options?) => void;

Parameters

path

PathLike

options?

force?

boolean

recursive?

boolean

Returns

void

stat

stat: (path, callback) => void;

Parameters

path

PathLike

callback

Callback<Stats>

Returns

void

statSync

statSync: (path) => Stats;

Parameters

path

PathLike

Returns

Stats

unlink

unlink: (path, callback) => void;

Parameters

path

PathLike

callback

Callback<void>

Returns

void

unlinkSync

unlinkSync: (path) => void;

Parameters

path

PathLike

Returns

void

writeFile

writeFile: (path, data, a, b?) => void;

Parameters

path

PathLike

data

WriteData

a

WriteOptions | Callback<void>

b?

Callback<void>

Returns

void

writeFileSync

writeFileSync: (path, data, options?) => void;

Parameters

path

PathLike

data

WriteData

options?

WriteOptions

Returns

void