index.d.ts

declare module 'nsfw' {
    interface NsfwFunction {
        (watchPath: string, eventCallback: (events: Array<FileChangeEvent>) => void, options?: Partial<Options>): Promise<NSFW>;
        actions: typeof ActionType;
    }

    /** Returns a Promise that resolves to the created NSFW Object.
    * @param {watchPath} watchPath - the path that nsfw should watchPath
    * @param {eventCallback} eventCallback - callback that will be fired when NSFW has change events
    * @param {options} options - options
    */
    var func: NsfwFunction;
    export default func;

    export interface NSFW {
        /** Returns a Promise that resolves when the NSFW object has started watching the path. */
        start: () => Promise<void>;
        /** Returns a Promise that resolves when NSFW object has halted. */
        stop: () => Promise<void>;
    }

    export const enum ActionType {
        CREATED = 0,
        DELETED = 1,
        MODIFIED = 2,
        RENAMED = 3
    }

    type CreatedFileEvent = GenericFileEvent<ActionType.CREATED>;
    type DeletedFileEvent = GenericFileEvent<ActionType.DELETED>;
    type ModifiedFileEvent = GenericFileEvent<ActionType.MODIFIED>;
    type FileChangeEvent = CreatedFileEvent | DeletedFileEvent | ModifiedFileEvent | RenamedFileEvent;

    interface RenamedFileEvent {
        /** the type of event that occurred */
        action: ActionType.RENAMED;
        /**  the name of the file before a rename*/
        oldFile: string;
        /** the new location of the file(only useful on linux) */
        newDirectory: string;
        /** the name of the file after a rename */
        newFile: string;
    }

    interface GenericFileEvent<T extends ActionType> {
        /** the type of event that occurred */
        action: T;
        /** the location the event took place */
        directory: string;
        /** the name of the file that was changed(Not available for rename events) */
        file: string;
    }

    interface Options {
        /** time in milliseconds to debounce the event callback */
        debounceMS?: number;
        /**  callback to fire in the case of errors */
        errorCallback: (err: any) => void
    }
}