@e-mc/watch

* NodeJS 18.20.5 LTS
* ES2022

General Usage

* Read the Docs

Interface

* View Source

``typescript
import type { IFileManager, ModuleConstructor } from "./index";
import type { ExternalAsset } from "./asset";
import type { HostInitConfig, IClient, IPermission } from "./core";
import type { FinalizeResult, PostFinalizeCallback } from "./filemanager";
import type { WatchModule } from "./settings";
import type { IFileGroup, ModifiedPostFinalizeListener, SecureOptions } from "./watch";

import type * as ws from "ws";

interface IWatch extends IClient {
connectTimeout: number;
init(config?: HostInitConfig): this;
start(assets: ExternalAsset[], permission?: IPermission | null): void;
modified(watch: IFileGroup): Promise;
configureServer(options: SecureOptions): boolean;
setCA(value: string): boolean;
setSSLKey(value: string): boolean;
setSSLCert(value: string): boolean;
hasSecureProtocol(): boolean;
getRecursiveFiles(watch: IFileGroup): [string, string[]][];
whenModified?(assets: ExternalAsset[], postFinalize: PostFinalizeCallback): IFileManager;
whenModified?(assets: ExternalAsset[], sanitize?: boolean, postFinalize?: PostFinalizeCallback): IFileManager;
set assets(value: ExternalAsset[]);
get assets(): ExternalAsset[];
set interval(value);
get interval(): number;
set port(value);
get port(): number;
set securePort(value);
get securePort(): number;
set host(value);
get host(): IFileManager | null;
}

interface WatchConstructor extends ModuleConstructor {
createServer(port: number, active: boolean): ws.Server | null;
createServer(port: number, secure?: SecureOptions | null, active?: boolean): ws.Server | null;
shutdown(): void;
setTimeout(value: number | string): void;
checkTimeout(client: ws.WebSocket): boolean;
isConnectionError(err: unknown): boolean;
readonly prototype: IWatch;
new(module?: WatchModule): IWatch;
}
`

Settings

`typescript
import type { PermittedDirectories } from "./core";

import type { SecureVersion } from "tls";

interface WatchModule {
// handler: "@e-mc/watch";
extensions?: string[];
timeout?: number | string;
interval?: number | string;
port?: number;
secure?: {
port?: number;
ca?: string;
key?: string;
cert?: string;
passphrase?: string;
ciphers?: string;
version?: SecureVersion;
};
settings?: {
broadcast_id?: string | string[];
users?: Record>;
};
permission?: PermittedDirectories;
}
`

$3

`javascript
const Watch = require("@e-mc/watch");

const instance = new Watch({ interval: 100, port: 8080 });
instance.init();

instance.whenModified = (assets) => {
assets.forEach(item => console.log(item.uri));
};

const assets = [
{ localUri: "/path/workspace/output/image1.png", uri: "http://hostname/path/document1.png", watch: true },
{ localUri: "/path/workspace/output/image2.png", uri: "http://hostname/path/document2.png", watch: true }
];

instance.start(assets, { disk_read: ["/path/workspace/output/**"] });
``

References

- https://www.unpkg.com/@e-mc/types@0.13.7/lib/asset.d.ts
- https://www.unpkg.com/@e-mc/types@0.13.7/lib/core.d.ts
- https://www.unpkg.com/@e-mc/types@0.13.7/lib/filemanager.d.ts
- https://www.unpkg.com/@e-mc/types@0.13.7/lib/settings.d.ts
- https://www.unpkg.com/@e-mc/types@0.13.7/lib/watch.d.ts

* https://www.npmjs.com/package/@types/ws

LICENSE

BSD 3-Clause