mirror of
https://github.com/Elvanos/fantasia-archive.git
synced 2024-05-18 11:13:15 +12:00
updated readme and removed typefix since it is no longer necessary
This commit is contained in:
Elvanos
parent
ab82bbfc74
commit
348d497f74
|
|
@ -21,14 +21,6 @@ cd fantasia-archive-master
|
|||
npm install
|
||||
```
|
||||
|
||||
** Prep for build
|
||||
Due to issues with this package being written in somewhat older version of nodeJS, the script will fizzle out upon building due to wrong version of `.d.ts` file in one of the included NPM packages.
|
||||
|
||||
- The proper replacement file can be found in `_typeFix/index.d.ts`
|
||||
- The faulty file can be found in `node_modules\builder-util\node_modules\@types\fs-extra\index.d.ts`
|
||||
- To fix this issue, simply copy the contents of the proper replacement over the buggy faulty file (or just replace its contents)
|
||||
- Once this is done, the build should run as normal without any issues
|
||||
|
||||
## Optional: Start the app in development mode (hot-code reloading, error reporting, etc.)
|
||||
|
||||
If you don't know what's going on, skip this step.
|
||||
|
|
|
|||
328
_typeFix/index.d.ts
vendored
328
_typeFix/index.d.ts
vendored
|
|
@ -1,328 +0,0 @@
|
|||
// Type definitions for fs-extra 9.0
|
||||
// Project: https://github.com/jprichardson/node-fs-extra
|
||||
// Definitions by: Alan Agius <https://github.com/alan-agius4>,
|
||||
// midknight41 <https://github.com/midknight41>,
|
||||
// Brendan Forster <https://github.com/shiftkey>,
|
||||
// Mees van Dijk <https://github.com/mees->,
|
||||
// Justin Rockwood <https://github.com/jrockwood>,
|
||||
// Sang Dang <https://github.com/sangdth>,
|
||||
// Florian Keller <https://github.com/ffflorian>
|
||||
// Piotr Błażejewicz <https://github.com/peterblazejewicz>
|
||||
// Tiger Oakes <https://github.com/NotWoods>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
|
||||
/// <reference types="node" />
|
||||
|
||||
import * as fs from "fs";
|
||||
import Stats = fs.Stats;
|
||||
|
||||
export * from "fs";
|
||||
|
||||
export function copy(src: string, dest: string, options?: CopyOptions): Promise<void>;
|
||||
export function copy(src: string, dest: string, callback: (err: Error) => void): void;
|
||||
export function copy(src: string, dest: string, options: CopyOptions, callback: (err: Error) => void): void;
|
||||
export function copySync(src: string, dest: string, options?: CopyOptionsSync): void;
|
||||
|
||||
export function copyFile(src: string, dest: string, flags?: number): Promise<void>;
|
||||
export function copyFile(src: string, dest: string, callback: (err: Error) => void): void;
|
||||
export function copyFile(src: string, dest: string, flags: number, callback: (err: Error) => void): void;
|
||||
|
||||
export function move(src: string, dest: string, options?: MoveOptions): Promise<void>;
|
||||
export function move(src: string, dest: string, callback: (err: Error) => void): void;
|
||||
export function move(src: string, dest: string, options: MoveOptions, callback: (err: Error) => void): void;
|
||||
export function moveSync(src: string, dest: string, options?: MoveOptions): void;
|
||||
|
||||
export function createFile(file: string): Promise<void>;
|
||||
export function createFile(file: string, callback: (err: Error) => void): void;
|
||||
export function createFileSync(file: string): void;
|
||||
|
||||
export function createSymlink(src: string, dest: string, type: SymlinkType): Promise<void>;
|
||||
export function createSymlink(src: string, dest: string, type: SymlinkType, callback?: (err: Error) => void): void;
|
||||
export function createSymlinkSync(src: string, dest: string, type: SymlinkType): void;
|
||||
|
||||
export function ensureDir(path: string, options?: EnsureOptions | number): Promise<void>;
|
||||
export function ensureDir(path: string, options?: EnsureOptions | number, callback?: (err: Error) => void): void;
|
||||
export function ensureDirSync(path: string, options?: EnsureOptions | number): void;
|
||||
|
||||
export function mkdirs(dir: string): Promise<void>;
|
||||
export function mkdirs(dir: string, callback: (err: Error) => void): void;
|
||||
export function mkdirp(dir: string): Promise<void>;
|
||||
export function mkdirp(dir: string, callback: (err: Error) => void): void;
|
||||
export function mkdirsSync(dir: string): void;
|
||||
export function mkdirpSync(dir: string): void;
|
||||
|
||||
export function outputFile(file: string, data: any, options?: WriteFileOptions | string): Promise<void>;
|
||||
export function outputFile(file: string, data: any, callback: (err: Error) => void): void;
|
||||
export function outputFile(file: string, data: any, options: WriteFileOptions | string, callback: (err: Error) => void): void;
|
||||
export function outputFileSync(file: string, data: any, options?: WriteFileOptions | string): void;
|
||||
|
||||
export function readJson(file: string, options?: ReadOptions): Promise<any>;
|
||||
export function readJson(file: string, callback: (err: Error, jsonObject: any) => void): void;
|
||||
export function readJson(file: string, options: ReadOptions, callback: (err: Error, jsonObject: any) => void): void;
|
||||
export function readJSON(file: string, options?: ReadOptions): Promise<any>;
|
||||
export function readJSON(file: string, callback: (err: Error, jsonObject: any) => void): void;
|
||||
export function readJSON(file: string, options: ReadOptions, callback: (err: Error, jsonObject: any) => void): void;
|
||||
|
||||
export function readJsonSync(file: string, options?: ReadOptions): any;
|
||||
export function readJSONSync(file: string, options?: ReadOptions): any;
|
||||
|
||||
export function remove(dir: string): Promise<void>;
|
||||
export function remove(dir: string, callback: (err: Error) => void): void;
|
||||
export function removeSync(dir: string): void;
|
||||
|
||||
export function outputJSON(file: string, data: any, options?: WriteOptions): Promise<void>;
|
||||
export function outputJSON(file: string, data: any, options: WriteOptions, callback: (err: Error) => void): void;
|
||||
export function outputJSON(file: string, data: any, callback: (err: Error) => void): void;
|
||||
export function outputJson(file: string, data: any, options?: WriteOptions): Promise<void>;
|
||||
export function outputJson(file: string, data: any, options: WriteOptions, callback: (err: Error) => void): void;
|
||||
export function outputJson(file: string, data: any, callback: (err: Error) => void): void;
|
||||
export function outputJsonSync(file: string, data: any, options?: WriteOptions): void;
|
||||
export function outputJSONSync(file: string, data: any, options?: WriteOptions): void;
|
||||
|
||||
export function writeJSON(file: string, object: any, options?: WriteOptions): Promise<void>;
|
||||
export function writeJSON(file: string, object: any, callback: (err: Error) => void): void;
|
||||
export function writeJSON(file: string, object: any, options: WriteOptions, callback: (err: Error) => void): void;
|
||||
export function writeJson(file: string, object: any, options?: WriteOptions): Promise<void>;
|
||||
export function writeJson(file: string, object: any, callback: (err: Error) => void): void;
|
||||
export function writeJson(file: string, object: any, options: WriteOptions, callback: (err: Error) => void): void;
|
||||
|
||||
export function writeJsonSync(file: string, object: any, options?: WriteOptions): void;
|
||||
export function writeJSONSync(file: string, object: any, options?: WriteOptions): void;
|
||||
|
||||
export function ensureFile(path: string): Promise<void>;
|
||||
export function ensureFile(path: string, callback: (err: Error) => void): void;
|
||||
export function ensureFileSync(path: string): void;
|
||||
|
||||
export function ensureLink(src: string, dest: string): Promise<void>;
|
||||
export function ensureLink(src: string, dest: string, callback: (err: Error) => void): void;
|
||||
export function ensureLinkSync(src: string, dest: string): void;
|
||||
|
||||
export function ensureSymlink(src: string, dest: string, type?: SymlinkType): Promise<void>;
|
||||
export function ensureSymlink(src: string, dest: string, type: SymlinkType, callback: (err: Error) => void): void;
|
||||
export function ensureSymlink(src: string, dest: string, callback: (err: Error) => void): void;
|
||||
export function ensureSymlinkSync(src: string, dest: string, type?: SymlinkType): void;
|
||||
|
||||
export function emptyDir(path: string): Promise<void>;
|
||||
export function emptyDir(path: string, callback: (err: Error) => void): void;
|
||||
export function emptyDirSync(path: string): void;
|
||||
|
||||
export function pathExists(path: string): Promise<boolean>;
|
||||
export function pathExists(path: string, callback: (err: Error, exists: boolean) => void): void;
|
||||
export function pathExistsSync(path: string): boolean;
|
||||
|
||||
// fs async methods
|
||||
// copied from https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/node/v6/index.d.ts
|
||||
|
||||
export function access(path: string | Buffer, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function access(path: string | Buffer, mode: number, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function access(path: string | Buffer, mode?: number): Promise<void>;
|
||||
|
||||
export function appendFile(file: string | Buffer | number, data: any, options: { encoding?: string; mode?: number | string; flag?: string; },
|
||||
callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function appendFile(file: string | Buffer | number, data: any, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function appendFile(file: string | Buffer | number, data: any, options?: { encoding?: string; mode?: number | string; flag?: string; }): Promise<void>;
|
||||
|
||||
export function chmod(path: string | Buffer, mode: string | number, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function chmod(path: string | Buffer, mode: string | number): Promise<void>;
|
||||
|
||||
export function chown(path: string | Buffer, uid: number, gid: number): Promise<void>;
|
||||
export function chown(path: string | Buffer, uid: number, gid: number, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
|
||||
export function close(fd: number, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function close(fd: number): Promise<void>;
|
||||
|
||||
export function fchmod(fd: number, mode: string | number, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function fchmod(fd: number, mode: string | number): Promise<void>;
|
||||
|
||||
export function fchown(fd: number, uid: number, gid: number, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function fchown(fd: number, uid: number, gid: number): Promise<void>;
|
||||
|
||||
export function fdatasync(fd: number, callback: () => void): void;
|
||||
export function fdatasync(fd: number): Promise<void>;
|
||||
|
||||
export function fstat(fd: number, callback: (err: NodeJS.ErrnoException, stats: Stats) => any): void;
|
||||
export function fstat(fd: number): Promise<Stats>;
|
||||
|
||||
export function fsync(fd: number, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function fsync(fd: number): Promise<void>;
|
||||
|
||||
export function ftruncate(fd: number, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function ftruncate(fd: number, len: number, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function ftruncate(fd: number, len?: number): Promise<void>;
|
||||
|
||||
export function futimes(fd: number, atime: number, mtime: number, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function futimes(fd: number, atime: Date, mtime: Date, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function futimes(fd: number, atime: number, mtime: number): Promise<void>;
|
||||
export function futimes(fd: number, atime: Date, mtime: Date): Promise<void>;
|
||||
|
||||
export function lchown(path: string | Buffer, uid: number, gid: number, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function lchown(path: string | Buffer, uid: number, gid: number): Promise<void>;
|
||||
|
||||
export function link(srcpath: string | Buffer, dstpath: string | Buffer, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function link(srcpath: string | Buffer, dstpath: string | Buffer): Promise<void>;
|
||||
|
||||
export function lstat(path: string | Buffer, callback: (err: NodeJS.ErrnoException, stats: Stats) => any): void;
|
||||
export function lstat(path: string | Buffer): Promise<Stats>;
|
||||
|
||||
/**
|
||||
* Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777.
|
||||
*
|
||||
* @param callback No arguments other than a possible exception are given to the completion callback.
|
||||
*/
|
||||
export function mkdir(path: string | Buffer, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
/**
|
||||
* Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777.
|
||||
*
|
||||
* @param callback No arguments other than a possible exception are given to the completion callback.
|
||||
*/
|
||||
export function mkdir(path: string | Buffer, mode: number | string, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function mkdir(path: string | Buffer): Promise<void>;
|
||||
|
||||
export function open(path: string | Buffer, flags: string | number, callback: (err: NodeJS.ErrnoException, fd: number) => void): void;
|
||||
export function open(path: string | Buffer, flags: string | number, mode: number, callback: (err: NodeJS.ErrnoException, fd: number) => void): void;
|
||||
export function open(path: string | Buffer, flags: string | number, mode?: number): Promise<number>;
|
||||
|
||||
export function read(fd: number, buffer: Buffer, offset: number, length: number, position: number | null,
|
||||
callback: (err: NodeJS.ErrnoException, bytesRead: number, buffer: Buffer) => void): void;
|
||||
export function read(fd: number, buffer: Buffer, offset: number, length: number, position: number | null): Promise<ReadResult>;
|
||||
|
||||
export function readFile(file: string | Buffer | number, callback: (err: NodeJS.ErrnoException, data: Buffer) => void): void;
|
||||
export function readFile(file: string | Buffer | number, encoding: string, callback: (err: NodeJS.ErrnoException, data: string) => void): void;
|
||||
export function readFile(file: string | Buffer | number, options: { flag?: string; } | { encoding: string; flag?: string; }, callback: (err: NodeJS.ErrnoException, data: Buffer) => void): void;
|
||||
export function readFile(file: string | Buffer | number, options: { flag?: string; } | { encoding: string; flag?: string; }): Promise<string>;
|
||||
// tslint:disable-next-line:unified-signatures
|
||||
export function readFile(file: string | Buffer | number, encoding: string): Promise<string>;
|
||||
export function readFile(file: string | Buffer | number): Promise<Buffer>;
|
||||
|
||||
export function readdir(path: string | Buffer, callback: (err: NodeJS.ErrnoException, files: string[]) => void): void;
|
||||
export function readdir(path: string | Buffer): Promise<string[]>;
|
||||
|
||||
export function readlink(path: string | Buffer, callback: (err: NodeJS.ErrnoException, linkString: string) => any): void;
|
||||
export function readlink(path: string | Buffer): Promise<string>;
|
||||
|
||||
export function realpath(path: string | Buffer, callback: (err: NodeJS.ErrnoException, resolvedPath: string) => any): void;
|
||||
export function realpath(path: string | Buffer, cache: { [path: string]: string }, callback: (err: NodeJS.ErrnoException, resolvedPath: string) => any): void;
|
||||
export function realpath(path: string | Buffer, cache?: { [path: string]: string }): Promise<string>;
|
||||
|
||||
export function rename(oldPath: string, newPath: string, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function rename(oldPath: string, newPath: string): Promise<void>;
|
||||
|
||||
/**
|
||||
* Asynchronous rmdir - removes the directory specified in {path}
|
||||
*
|
||||
* @param callback No arguments other than a possible exception are given to the completion callback.
|
||||
*/
|
||||
export function rmdir(path: string | Buffer, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function rmdir(path: string | Buffer): Promise<void>;
|
||||
|
||||
export function stat(path: string | Buffer, callback: (err: NodeJS.ErrnoException, stats: Stats) => any): void;
|
||||
export function stat(path: string | Buffer): Promise<Stats>;
|
||||
|
||||
export function symlink(srcpath: string | Buffer, dstpath: string | Buffer, type: FsSymlinkType | undefined, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function symlink(srcpath: string | Buffer, dstpath: string | Buffer, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function symlink(srcpath: string | Buffer, dstpath: string | Buffer, type?: FsSymlinkType): Promise<void>;
|
||||
|
||||
export function truncate(path: string | Buffer, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function truncate(path: string | Buffer, len: number, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function truncate(path: string | Buffer, len?: number): Promise<void>;
|
||||
|
||||
/**
|
||||
* Asynchronous unlink - deletes the file specified in {path}
|
||||
*
|
||||
* @param callback No arguments other than a possible exception are given to the completion callback.
|
||||
*/
|
||||
export function unlink(path: string | Buffer, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function unlink(path: string | Buffer): Promise<void>;
|
||||
|
||||
export function utimes(path: string | Buffer, atime: number, mtime: number, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function utimes(path: string | Buffer, atime: Date, mtime: Date, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function utimes(path: string | Buffer, atime: number, mtime: number): Promise<void>;
|
||||
export function utimes(path: string | Buffer, atime: Date, mtime: Date): Promise<void>;
|
||||
|
||||
export function write(fd: number, buffer: Buffer, offset: number, length: number, position: number | null, callback: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void;
|
||||
export function write(fd: number, buffer: Buffer, offset: number, length: number, callback: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void;
|
||||
export function write(fd: number, data: any, callback: (err: NodeJS.ErrnoException, written: number, str: string) => void): void;
|
||||
export function write(fd: number, data: any, offset: number, callback: (err: NodeJS.ErrnoException, written: number, str: string) => void): void;
|
||||
export function write(fd: number, data: any, offset: number, encoding: string, callback: (err: NodeJS.ErrnoException, written: number, str: string) => void): void;
|
||||
export function write(fd: number, buffer: Buffer, offset?: number, length?: number, position?: number | null): Promise<WriteResult>;
|
||||
export function write(fd: number, data: any, offset?: number, encoding?: string): Promise<WriteResult>;
|
||||
|
||||
export function writeFile(file: string | Buffer | number, data: any, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
export function writeFile(file: string | Buffer | number, data: any, options?: WriteFileOptions | string): Promise<void>;
|
||||
export function writeFile(file: string | Buffer | number, data: any, options: WriteFileOptions | string, callback: (err: NodeJS.ErrnoException) => void): void;
|
||||
|
||||
/**
|
||||
* Asynchronous mkdtemp - Creates a unique temporary directory. Generates six random characters to be appended behind a required prefix to create a unique temporary directory.
|
||||
*
|
||||
* @param callback The created folder path is passed as a string to the callback's second parameter.
|
||||
*/
|
||||
export function mkdtemp(prefix: string): Promise<string>;
|
||||
export function mkdtemp(prefix: string, callback: (err: NodeJS.ErrnoException, folder: string) => void): void;
|
||||
|
||||
export interface PathEntry {
|
||||
path: string;
|
||||
stats: Stats;
|
||||
}
|
||||
|
||||
export interface PathEntryStream {
|
||||
read(): PathEntry | null;
|
||||
}
|
||||
|
||||
export type CopyFilterSync = (src: string, dest: string) => boolean;
|
||||
export type CopyFilterAsync = (src: string, dest: string) => Promise<boolean>;
|
||||
|
||||
export type SymlinkType = "dir" | "file";
|
||||
export type FsSymlinkType = "dir" | "file" | "junction";
|
||||
|
||||
export interface CopyOptions {
|
||||
dereference?: boolean;
|
||||
overwrite?: boolean;
|
||||
preserveTimestamps?: boolean;
|
||||
errorOnExist?: boolean;
|
||||
filter?: CopyFilterSync | CopyFilterAsync;
|
||||
recursive?: boolean;
|
||||
}
|
||||
|
||||
export interface CopyOptionsSync extends CopyOptions {
|
||||
filter?: CopyFilterSync;
|
||||
}
|
||||
|
||||
export interface EnsureOptions {
|
||||
mode?: number;
|
||||
}
|
||||
|
||||
export interface MoveOptions {
|
||||
overwrite?: boolean;
|
||||
limit?: number;
|
||||
}
|
||||
|
||||
export interface ReadOptions {
|
||||
throws?: boolean;
|
||||
fs?: object;
|
||||
reviver?: any;
|
||||
encoding?: string;
|
||||
flag?: string;
|
||||
}
|
||||
|
||||
export interface WriteFileOptions {
|
||||
encoding?: string;
|
||||
flag?: string;
|
||||
mode?: number;
|
||||
}
|
||||
|
||||
export interface WriteOptions extends WriteFileOptions {
|
||||
fs?: object;
|
||||
replacer?: any;
|
||||
spaces?: number | string;
|
||||
EOL?: string;
|
||||
}
|
||||
|
||||
export interface ReadResult {
|
||||
bytesRead: number;
|
||||
buffer: Buffer;
|
||||
}
|
||||
|
||||
export interface WriteResult {
|
||||
bytesWritten: number;
|
||||
buffer: Buffer;
|
||||
}
|
||||
Loading…
Reference in a new issue