mirror of
https://github.com/FlipsideCrypto/DefinitelyTyped.git
synced 2026-02-06 19:07:08 +00:00
moved decls within external namespace
This commit is contained in:
Peter Snider
parent
d667c03c07
commit
ae242862e5
435
seneca/seneca.d.ts
vendored
435
seneca/seneca.d.ts
vendored
@ -3,227 +3,224 @@
|
||||
// Definitions by: Peter Snider <https://github.com/psnider/>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped/seneca
|
||||
|
||||
declare function SNS(options?: SNS.Options): SNS.Instance;
|
||||
|
||||
declare namespace SNS {
|
||||
|
||||
type UnknownType = any;
|
||||
|
||||
|
||||
interface Options {
|
||||
[plugin_name: string]: any;
|
||||
tag?: string;
|
||||
// Standard length of identifiers for actions.
|
||||
idlen?: number;
|
||||
// Standard timeout for actions.
|
||||
timeout?: number; // milliseconds
|
||||
// Register (true) default plugins. Set false to not register when
|
||||
// using custom versions.
|
||||
default_plugins?: {
|
||||
basic?: boolean;
|
||||
'mem-store'?: boolean;
|
||||
transport?: boolean;
|
||||
web?: boolean;
|
||||
};
|
||||
// Settings for network REPL.
|
||||
repl?: {
|
||||
port?: number;
|
||||
host?: string;
|
||||
};
|
||||
// Debug settings.
|
||||
debug?: {
|
||||
// Throw (some) errors from seneca.act.
|
||||
fragile?: boolean;
|
||||
// Fatal errors ... aren't fatal. Not for production!
|
||||
undead?: boolean;
|
||||
// Print debug info to console
|
||||
print?: {
|
||||
// Print options. Best used via --seneca.print.options.
|
||||
options?: boolean;
|
||||
};
|
||||
// Trace action caller and place in args.caller$.
|
||||
act_caller?: boolean;
|
||||
// Shorten all identifiers to 2 characters.
|
||||
short_logs?: boolean;
|
||||
// Record and log callpoints (calling code locations).
|
||||
callpoint?: boolean;
|
||||
};
|
||||
// Enforce strict behaviours. Relax when backwards compatibility needed.
|
||||
strict?: {
|
||||
// Action result must be a plain object.
|
||||
result?: boolean;
|
||||
// Delegate fixedargs override action args.
|
||||
fixedargs?: boolean;
|
||||
// Adding a pattern overrides existing pattern only if matches exactly.
|
||||
add?: boolean;
|
||||
};
|
||||
// Action cache. Makes inbound messages idempotent.
|
||||
actcache?: {
|
||||
active?: boolean;
|
||||
size?: number;
|
||||
};
|
||||
// Action executor tracing. See gate-executor module.
|
||||
trace?: {
|
||||
act?: boolean;
|
||||
stack?: boolean;
|
||||
unknown?: string;
|
||||
},
|
||||
// Action statistics settings. See rolling-stats module.
|
||||
stats?: {
|
||||
size?: number;
|
||||
interval?: number;
|
||||
running?: boolean;
|
||||
};
|
||||
// Wait time for plugins to close gracefully.
|
||||
deathdelay?: number;
|
||||
// Default seneca-admin settings.
|
||||
// TODO: move to seneca-admin!
|
||||
admin?: {
|
||||
local?: boolean;
|
||||
prefix?: string;
|
||||
};
|
||||
// Plugin settings
|
||||
plugin?: any;
|
||||
// Internal settings.
|
||||
internal?: {
|
||||
// Close instance on these signals, if true.
|
||||
close_signals?: {
|
||||
SIGHUP?: boolean;
|
||||
SIGTERM?: boolean;
|
||||
SIGINT?: boolean;
|
||||
SIGBREAK?: boolean;
|
||||
};
|
||||
actrouter?: UnknownType;
|
||||
clientrouter?: UnknownType;
|
||||
subrouter?: UnknownType;
|
||||
};
|
||||
// Log status at periodic intervals.
|
||||
status?: {
|
||||
interval?: number;
|
||||
// By default, does not run.
|
||||
running?: boolean;
|
||||
},
|
||||
// zig module settings for seneca.start() chaining.
|
||||
zig?: any;
|
||||
log?: {
|
||||
short?: boolean;
|
||||
};
|
||||
errhandler?: GlobalErrorHandler;
|
||||
}
|
||||
|
||||
interface MinimalPattern {
|
||||
//role?: string;
|
||||
//cmd?: string;
|
||||
}
|
||||
|
||||
interface Optioner {
|
||||
set: (input: string | Options) => Options;
|
||||
get: () => Options;
|
||||
}
|
||||
|
||||
type ExecutorWorker = (callback: any) => void;
|
||||
type ExecutorCallback = (err: Error, result: any) => void;
|
||||
interface Executor {
|
||||
id: string;
|
||||
desc: string;
|
||||
fn: ExecutorWorker;
|
||||
cb: ExecutorCallback;
|
||||
gate: boolean;
|
||||
ungate: boolean;
|
||||
execute: UnknownType;
|
||||
}
|
||||
|
||||
interface PluginOptions {
|
||||
}
|
||||
type PluginModule = (options: any) => void;
|
||||
|
||||
interface ClientOptions {
|
||||
}
|
||||
|
||||
interface ListenOptions {
|
||||
}
|
||||
|
||||
interface EntityDataWithQuery {
|
||||
[entityKey: string]: any;
|
||||
id?: string;
|
||||
sort$?: any;
|
||||
}
|
||||
|
||||
|
||||
|
||||
type Pattern = string | MinimalPattern;
|
||||
type GlobalErrorHandler = (error: Error) => void;
|
||||
type AddCallback = (msg: any, respond: (error: Error, msg: any) => void) => void;
|
||||
type ActCallback = (error: Error, result: any) => void;
|
||||
type CloseCallback = (optional: any, done: (error: Error) => void) => void;
|
||||
type DatabaseID = string;
|
||||
type EntitySaveCallback = (error: Error, result: any) => void;
|
||||
type EntityLoadCallback = (error: Error, result: any) => void;
|
||||
type EntityRemoveCallback = (error: Error) => void;
|
||||
type EntityListCallback = (error: Error, result: any[]) => void;
|
||||
|
||||
|
||||
|
||||
|
||||
interface Instance {
|
||||
version: string;
|
||||
|
||||
options(options: Options): void;
|
||||
|
||||
error(handler: GlobalErrorHandler): void;
|
||||
on(eventName: string, callback: (error: Error) => void): any;
|
||||
close(callback: CloseCallback): void;
|
||||
use(module: PluginModule, options?: PluginOptions): this;
|
||||
use(name: string, options?: PluginOptions): this;
|
||||
client(options?: ClientOptions): this;
|
||||
listen(options?: ListenOptions): this;
|
||||
|
||||
ready(callback: (error: Error) => void): void;
|
||||
|
||||
add(pattern: Pattern, action: AddCallback): this;
|
||||
add(pattern: Pattern, paramspec: any, action: AddCallback): this;
|
||||
act(pattern: Pattern, respond: ActCallback): void;
|
||||
act(pattern: Pattern, msg: any, respond: ActCallback): void;
|
||||
make(entity_canon: string, properties?: any): Entity;
|
||||
make(base: string, entity_canon: string, properties?: any): Entity;
|
||||
make(zone: string, base: string, entity_canon: string, properties?: any): Entity;
|
||||
|
||||
// @param name reference to plugin provided object
|
||||
export(name: string): PluginModule;
|
||||
|
||||
pin(pattern: Pattern): void;
|
||||
}
|
||||
|
||||
|
||||
// NOTE: senecas documented use of:
|
||||
// var product = seneca.make('product')
|
||||
// product.name = 'Apple'
|
||||
// causes this error: error TS2339: Property 'name' does not exist on type 'Entity'.
|
||||
// Change such references to: product['name']
|
||||
interface Entity {
|
||||
(canon: any, seneca: any): void;
|
||||
[fieldname: string]: any;
|
||||
// there appear to be many more variants of make$(), but its unclear that they are intended for the public API
|
||||
make$(): Entity;
|
||||
make$(name: string): Entity;
|
||||
make$(base: string, name: string): Entity;
|
||||
make$(zone: string, base: string, name: string): Entity;
|
||||
|
||||
save$(callback: EntitySaveCallback): void;
|
||||
save$(props: EntityDataWithQuery, callback: EntitySaveCallback): void;
|
||||
load$(id: DatabaseID | EntityDataWithQuery, callback: EntityLoadCallback): void;
|
||||
remove$(id: DatabaseID | EntityDataWithQuery, callback: EntityRemoveCallback): void;
|
||||
list$(query: EntityDataWithQuery, callback: EntityListCallback): void;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
|
||||
//export = SNS
|
||||
|
||||
|
||||
declare module "seneca" {
|
||||
|
||||
function SNS(options?: SNS.Options): SNS.Instance;
|
||||
|
||||
namespace SNS {
|
||||
|
||||
type UnknownType = any;
|
||||
|
||||
|
||||
interface Options {
|
||||
[plugin_name: string]: any;
|
||||
tag?: string;
|
||||
// Standard length of identifiers for actions.
|
||||
idlen?: number;
|
||||
// Standard timeout for actions.
|
||||
timeout?: number; // milliseconds
|
||||
// Register (true) default plugins. Set false to not register when
|
||||
// using custom versions.
|
||||
default_plugins?: {
|
||||
basic?: boolean;
|
||||
'mem-store'?: boolean;
|
||||
transport?: boolean;
|
||||
web?: boolean;
|
||||
};
|
||||
// Settings for network REPL.
|
||||
repl?: {
|
||||
port?: number;
|
||||
host?: string;
|
||||
};
|
||||
// Debug settings.
|
||||
debug?: {
|
||||
// Throw (some) errors from seneca.act.
|
||||
fragile?: boolean;
|
||||
// Fatal errors ... aren't fatal. Not for production!
|
||||
undead?: boolean;
|
||||
// Print debug info to console
|
||||
print?: {
|
||||
// Print options. Best used via --seneca.print.options.
|
||||
options?: boolean;
|
||||
};
|
||||
// Trace action caller and place in args.caller$.
|
||||
act_caller?: boolean;
|
||||
// Shorten all identifiers to 2 characters.
|
||||
short_logs?: boolean;
|
||||
// Record and log callpoints (calling code locations).
|
||||
callpoint?: boolean;
|
||||
};
|
||||
// Enforce strict behaviours. Relax when backwards compatibility needed.
|
||||
strict?: {
|
||||
// Action result must be a plain object.
|
||||
result?: boolean;
|
||||
// Delegate fixedargs override action args.
|
||||
fixedargs?: boolean;
|
||||
// Adding a pattern overrides existing pattern only if matches exactly.
|
||||
add?: boolean;
|
||||
};
|
||||
// Action cache. Makes inbound messages idempotent.
|
||||
actcache?: {
|
||||
active?: boolean;
|
||||
size?: number;
|
||||
};
|
||||
// Action executor tracing. See gate-executor module.
|
||||
trace?: {
|
||||
act?: boolean;
|
||||
stack?: boolean;
|
||||
unknown?: string;
|
||||
},
|
||||
// Action statistics settings. See rolling-stats module.
|
||||
stats?: {
|
||||
size?: number;
|
||||
interval?: number;
|
||||
running?: boolean;
|
||||
};
|
||||
// Wait time for plugins to close gracefully.
|
||||
deathdelay?: number;
|
||||
// Default seneca-admin settings.
|
||||
// TODO: move to seneca-admin!
|
||||
admin?: {
|
||||
local?: boolean;
|
||||
prefix?: string;
|
||||
};
|
||||
// Plugin settings
|
||||
plugin?: any;
|
||||
// Internal settings.
|
||||
internal?: {
|
||||
// Close instance on these signals, if true.
|
||||
close_signals?: {
|
||||
SIGHUP?: boolean;
|
||||
SIGTERM?: boolean;
|
||||
SIGINT?: boolean;
|
||||
SIGBREAK?: boolean;
|
||||
};
|
||||
actrouter?: UnknownType;
|
||||
clientrouter?: UnknownType;
|
||||
subrouter?: UnknownType;
|
||||
};
|
||||
// Log status at periodic intervals.
|
||||
status?: {
|
||||
interval?: number;
|
||||
// By default, does not run.
|
||||
running?: boolean;
|
||||
},
|
||||
// zig module settings for seneca.start() chaining.
|
||||
zig?: any;
|
||||
log?: {
|
||||
short?: boolean;
|
||||
};
|
||||
errhandler?: GlobalErrorHandler;
|
||||
}
|
||||
|
||||
interface MinimalPattern {
|
||||
//role?: string;
|
||||
//cmd?: string;
|
||||
}
|
||||
|
||||
interface Optioner {
|
||||
set: (input: string | Options) => Options;
|
||||
get: () => Options;
|
||||
}
|
||||
|
||||
type ExecutorWorker = (callback: any) => void;
|
||||
type ExecutorCallback = (err: Error, result: any) => void;
|
||||
interface Executor {
|
||||
id: string;
|
||||
desc: string;
|
||||
fn: ExecutorWorker;
|
||||
cb: ExecutorCallback;
|
||||
gate: boolean;
|
||||
ungate: boolean;
|
||||
execute: UnknownType;
|
||||
}
|
||||
|
||||
interface PluginOptions {
|
||||
}
|
||||
type PluginModule = (options: any) => void;
|
||||
|
||||
interface ClientOptions {
|
||||
}
|
||||
|
||||
interface ListenOptions {
|
||||
}
|
||||
|
||||
interface EntityDataWithQuery {
|
||||
[entityKey: string]: any;
|
||||
id?: string;
|
||||
sort$?: any;
|
||||
}
|
||||
|
||||
|
||||
|
||||
type Pattern = string | MinimalPattern;
|
||||
type GlobalErrorHandler = (error: Error) => void;
|
||||
type AddCallback = (msg: any, respond: (error: Error, msg: any) => void) => void;
|
||||
type ActCallback = (error: Error, result: any) => void;
|
||||
type CloseCallback = (optional: any, done: (error: Error) => void) => void;
|
||||
type DatabaseID = string;
|
||||
type EntitySaveCallback = (error: Error, result: any) => void;
|
||||
type EntityLoadCallback = (error: Error, result: any) => void;
|
||||
type EntityRemoveCallback = (error: Error) => void;
|
||||
type EntityListCallback = (error: Error, result: any[]) => void;
|
||||
|
||||
|
||||
|
||||
|
||||
interface Instance {
|
||||
version: string;
|
||||
|
||||
options(options: Options): void;
|
||||
|
||||
error(handler: GlobalErrorHandler): void;
|
||||
on(eventName: string, callback: (error: Error) => void): any;
|
||||
close(callback: CloseCallback): void;
|
||||
use(module: PluginModule, options?: PluginOptions): this;
|
||||
use(name: string, options?: PluginOptions): this;
|
||||
client(options?: ClientOptions): this;
|
||||
listen(options?: ListenOptions): this;
|
||||
|
||||
ready(callback: (error: Error) => void): void;
|
||||
|
||||
add(pattern: Pattern, action: AddCallback): this;
|
||||
add(pattern: Pattern, paramspec: any, action: AddCallback): this;
|
||||
act(pattern: Pattern, respond: ActCallback): void;
|
||||
act(pattern: Pattern, msg: any, respond: ActCallback): void;
|
||||
make(entity_canon: string, properties?: any): Entity;
|
||||
make(base: string, entity_canon: string, properties?: any): Entity;
|
||||
make(zone: string, base: string, entity_canon: string, properties?: any): Entity;
|
||||
|
||||
// @param name reference to plugin provided object
|
||||
export(name: string): PluginModule;
|
||||
|
||||
pin(pattern: Pattern): void;
|
||||
}
|
||||
|
||||
|
||||
// NOTE: senecas documented use of:
|
||||
// var product = seneca.make('product')
|
||||
// product.name = 'Apple'
|
||||
// causes this error: error TS2339: Property 'name' does not exist on type 'Entity'.
|
||||
// Change such references to: product['name']
|
||||
interface Entity {
|
||||
(canon: any, seneca: any): void;
|
||||
[fieldname: string]: any;
|
||||
// there appear to be many more variants of make$(), but its unclear that they are intended for the public API
|
||||
make$(): Entity;
|
||||
make$(name: string): Entity;
|
||||
make$(base: string, name: string): Entity;
|
||||
make$(zone: string, base: string, name: string): Entity;
|
||||
|
||||
save$(callback: EntitySaveCallback): void;
|
||||
save$(props: EntityDataWithQuery, callback: EntitySaveCallback): void;
|
||||
load$(id: DatabaseID | EntityDataWithQuery, callback: EntityLoadCallback): void;
|
||||
remove$(id: DatabaseID | EntityDataWithQuery, callback: EntityRemoveCallback): void;
|
||||
list$(query: EntityDataWithQuery, callback: EntityListCallback): void;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
export = SNS;
|
||||
}
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user