json-to-typed/dist/index.d.ts

Build to-typed objects from JSON files.

import { Convert, TConvertMap } from 'to-typed';
declare type Awaitable<T> = Promise<T> | T;
export declare class TypedJsonFile<T> {
    readonly path: string;
    readonly type: Convert<T>;
    private static readonly errGuard;
    private readonly awaitLock;
    constructor(path: string, type: Convert<T>);
    private static tryReadJson;
    read(): Promise<T>;
    write(data: T): Promise<void>;
    lock(options?: {
        timeout?: number;
    }): Promise<void>;
    unlock(): void;
    use<R>(fun: (self: TypedJsonFile<T>) => Promise<R>): Promise<R>;
    update(fun: (data: T) => Awaitable<T>): Promise<void>;
    static fromDefaults<S>(path: string, defaults: S): TypedJsonFile<TConvertMap<S>>;
}
export {};