Function asSentinelModule
- asSentinelModule<
TType extends
SentinelModule<
BaseParamsFields & {
account?: AccountInstance
| "random";
additionalSigners?: AccountInstance[];
addToResolvers?: boolean;
allowNameResolution?: boolean;
config: DeepRestrictToStringKeys<
{
allowedQueries?: string[];
archiving?: { archivists?: string[]; queries?: string[] };
archivist?: string;
automations?: (
| {
end?: number;
frequency?: number;
frequencyUnits?: "second"
| "minute"
| "hour"
| "day";
remaining?: number;
schema: "network.xyo.automation";
start: number;
type: "interval";
}
| {
end?: number;
frequency?: number;
frequencyUnits?: "second"
| "minute"
| "hour"
| "day";
remaining?: number;
schema: "network.xyo.automation.interval";
start: number;
type: "interval";
}
| {
end?: number;
frequency?: number;
frequencyUnits?: "second"
| "minute"
| "hour"
| "day";
remaining?: number;
schema: "network.xyo.automation.event";
start: number;
type: "interval";
}
| { schema: "network.xyo.automation"; type: "event" }
| { schema: "network.xyo.automation.interval"; type: "event" }
| { schema: "network.xyo.automation.event"; type: "event" }
)[];
consoleLogger?: any;
labels?: { [x: string]: undefined | string };
name?: string;
paging?: { [x: string]: { size?: number } };
retry?: { backoff?: number; interval?: number; retries?: number };
schema: string;
security?: {
allowAnonymous?: boolean;
allowed?: { [x: string]: ((...) | (...))[] };
disallowed?: { [x: string]: Lowercase<(...)>[] };
};
sign?: boolean;
storeQueries?: boolean;
synchronous?: boolean;
tasks: (
| {
endPoint?: | "commit"
| "all"
| "clear"
| "delete"
| "get"
| "insert";
input?: string
| boolean
| string[];
mod: string;
required?: boolean;
}
| {
endPoint?: "divine";
input?: string
| boolean
| string[];
mod: string;
required?: boolean;
}
| {
endPoint?: "observe";
input?: string
| boolean
| string[];
mod: string;
required?: boolean;
}
| {
endPoint?: string;
input?: string
| boolean
| string[];
mod: string;
required?: boolean;
}
)[];
throwErrors?: boolean;
timestamp?: boolean;
},
>;
ephemeralQueryAccountEnabled?: boolean;
moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
},
SentinelModuleEventData<
Module<
BaseParamsFields & {
account?: AccountInstance
| "random";
additionalSigners?: AccountInstance[];
addToResolvers?: boolean;
allowNameResolution?: boolean;
config: DeepRestrictToStringKeys<
{
allowedQueries?: string[];
archiving?: { archivists?: (...)[]; queries?: (...)[] };
archivist?: string;
consoleLogger?: any;
labels?: { [x: string]: undefined | string };
name?: string;
paging?: { [x: string]: { size?: (...) | (...) } };
retry?: { backoff?: number; interval?: number; retries?: number };
schema: string;
security?: {
allowAnonymous?: boolean;
allowed?: { [x: ...]: ... };
disallowed?: { [x: ...]: ... };
};
sign?: boolean;
storeQueries?: boolean;
timestamp?: boolean;
},
>;
ephemeralQueryAccountEnabled?: boolean;
moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
},
>,
>,
>,
>(
value: AnyNonPromise,
config?: TypeCheckConfig,
): undefined | TType Type Parameters
- TType extends SentinelModule<
BaseParamsFields & {
account?: AccountInstance
| "random";
additionalSigners?: AccountInstance[];
addToResolvers?: boolean;
allowNameResolution?: boolean;
config: DeepRestrictToStringKeys<
{
allowedQueries?: string[];
archiving?: { archivists?: string[]; queries?: string[] };
archivist?: string;
automations?: (
| {
end?: number;
frequency?: number;
frequencyUnits?: "second"
| "minute"
| "hour"
| "day";
remaining?: number;
schema: "network.xyo.automation";
start: number;
type: "interval";
}
| {
end?: number;
frequency?: number;
frequencyUnits?: "second"
| "minute"
| "hour"
| "day";
remaining?: number;
schema: "network.xyo.automation.interval";
start: number;
type: "interval";
}
| {
end?: number;
frequency?: number;
frequencyUnits?: "second"
| "minute"
| "hour"
| "day";
remaining?: number;
schema: "network.xyo.automation.event";
start: number;
type: "interval";
}
| { schema: "network.xyo.automation"; type: "event" }
| { schema: "network.xyo.automation.interval"; type: "event" }
| { schema: "network.xyo.automation.event"; type: "event" }
)[];
consoleLogger?: any;
labels?: { [x: string]: undefined | string };
name?: string;
paging?: { [x: string]: { size?: number } };
retry?: { backoff?: number; interval?: number; retries?: number };
schema: string;
security?: {
allowAnonymous?: boolean;
allowed?: { [x: string]: ((...) | (...))[] };
disallowed?: { [x: string]: Lowercase<(...)>[] };
};
sign?: boolean;
storeQueries?: boolean;
synchronous?: boolean;
tasks: (
| {
endPoint?: "commit"
| "all"
| "clear"
| "delete"
| "get"
| "insert";
input?: string | boolean | string[];
mod: string;
required?: boolean;
}
| {
endPoint?: "divine";
input?: string
| boolean
| string[];
mod: string;
required?: boolean;
}
| {
endPoint?: "observe";
input?: string
| boolean
| string[];
mod: string;
required?: boolean;
}
| {
endPoint?: string;
input?: string
| boolean
| string[];
mod: string;
required?: boolean;
}
)[];
throwErrors?: boolean;
timestamp?: boolean;
},
>;
ephemeralQueryAccountEnabled?: boolean;
moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
},
SentinelModuleEventData<
Module<
BaseParamsFields & {
account?: AccountInstance
| "random";
additionalSigners?: AccountInstance[];
addToResolvers?: boolean;
allowNameResolution?: boolean;
config: DeepRestrictToStringKeys<
{
allowedQueries?: string[];
archiving?: { archivists?: (...)[]; queries?: (...)[] };
archivist?: string;
consoleLogger?: any;
labels?: { [x: string]: undefined | string };
name?: string;
paging?: { [x: string]: { size?: (...) | (...) } };
retry?: { backoff?: number; interval?: number; retries?: number };
schema: string;
security?: {
allowAnonymous?: boolean;
allowed?: { [x: ...]: ... };
disallowed?: { [x: ...]: ... };
};
sign?: boolean;
storeQueries?: boolean;
timestamp?: boolean;
},
>;
ephemeralQueryAccountEnabled?: boolean;
moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
},
>,
>,
>
Returns undefined | TType
- asSentinelModule<
TType extends
SentinelModule<
BaseParamsFields & {
account?: AccountInstance
| "random";
additionalSigners?: AccountInstance[];
addToResolvers?: boolean;
allowNameResolution?: boolean;
config: DeepRestrictToStringKeys<
{
allowedQueries?: string[];
archiving?: { archivists?: string[]; queries?: string[] };
archivist?: string;
automations?: (
| {
end?: number;
frequency?: number;
frequencyUnits?: "second"
| "minute"
| "hour"
| "day";
remaining?: number;
schema: "network.xyo.automation";
start: number;
type: "interval";
}
| {
end?: number;
frequency?: number;
frequencyUnits?: "second"
| "minute"
| "hour"
| "day";
remaining?: number;
schema: "network.xyo.automation.interval";
start: number;
type: "interval";
}
| {
end?: number;
frequency?: number;
frequencyUnits?: "second"
| "minute"
| "hour"
| "day";
remaining?: number;
schema: "network.xyo.automation.event";
start: number;
type: "interval";
}
| { schema: "network.xyo.automation"; type: "event" }
| { schema: "network.xyo.automation.interval"; type: "event" }
| { schema: "network.xyo.automation.event"; type: "event" }
)[];
consoleLogger?: any;
labels?: { [x: string]: undefined | string };
name?: string;
paging?: { [x: string]: { size?: number } };
retry?: { backoff?: number; interval?: number; retries?: number };
schema: string;
security?: {
allowAnonymous?: boolean;
allowed?: { [x: string]: ((...) | (...))[] };
disallowed?: { [x: string]: Lowercase<(...)>[] };
};
sign?: boolean;
storeQueries?: boolean;
synchronous?: boolean;
tasks: (
| {
endPoint?: | "commit"
| "all"
| "clear"
| "delete"
| "get"
| "insert";
input?: string
| boolean
| string[];
mod: string;
required?: boolean;
}
| {
endPoint?: "divine";
input?: string
| boolean
| string[];
mod: string;
required?: boolean;
}
| {
endPoint?: "observe";
input?: string
| boolean
| string[];
mod: string;
required?: boolean;
}
| {
endPoint?: string;
input?: string
| boolean
| string[];
mod: string;
required?: boolean;
}
)[];
throwErrors?: boolean;
timestamp?: boolean;
},
>;
ephemeralQueryAccountEnabled?: boolean;
moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
},
SentinelModuleEventData<
Module<
BaseParamsFields & {
account?: AccountInstance
| "random";
additionalSigners?: AccountInstance[];
addToResolvers?: boolean;
allowNameResolution?: boolean;
config: DeepRestrictToStringKeys<
{
allowedQueries?: string[];
archiving?: { archivists?: (...)[]; queries?: (...)[] };
archivist?: string;
consoleLogger?: any;
labels?: { [x: string]: undefined | string };
name?: string;
paging?: { [x: string]: { size?: (...) | (...) } };
retry?: { backoff?: number; interval?: number; retries?: number };
schema: string;
security?: {
allowAnonymous?: boolean;
allowed?: { [x: ...]: ... };
disallowed?: { [x: ...]: ... };
};
sign?: boolean;
storeQueries?: boolean;
timestamp?: boolean;
},
>;
ephemeralQueryAccountEnabled?: boolean;
moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
},
>,
>,
>,
>(
value: AnyNonPromise,
assert: StringOrAlertFunction<
SentinelModule<
BaseParamsFields & {
account?: AccountInstance
| "random";
additionalSigners?: AccountInstance[];
addToResolvers?: boolean;
allowNameResolution?: boolean;
config: DeepRestrictToStringKeys<
{
allowedQueries?: string[];
archiving?: { archivists?: string[]; queries?: string[] };
archivist?: string;
automations?: (
| {
end?: (...)
| (...);
frequency?: (...) | (...);
frequencyUnits?: (...) | (...) | (...) | (...) | (...);
remaining?: (...) | (...);
schema: "network.xyo.automation";
start: number;
type: "interval";
}
| {
end?: (...)
| (...);
frequency?: (...) | (...);
frequencyUnits?: (...) | (...) | (...) | (...) | (...);
remaining?: (...) | (...);
schema: "network.xyo.automation.interval";
start: number;
type: "interval";
}
| {
end?: (...)
| (...);
frequency?: (...) | (...);
frequencyUnits?: (...) | (...) | (...) | (...) | (...);
remaining?: (...) | (...);
schema: "network.xyo.automation.event";
start: number;
type: "interval";
}
| { schema: "network.xyo.automation"; type: "event" }
| { schema: "network.xyo.automation.interval"; type: "event" }
| { schema: "network.xyo.automation.event"; type: "event" }
)[];
consoleLogger?: any;
labels?: { [x: string]: undefined | string };
name?: string;
paging?: { [x: string]: { size?: number } };
retry?: { backoff?: number; interval?: number; retries?: number };
schema: string;
security?: {
allowAnonymous?: boolean;
allowed?: { [x: string]: (...)[] };
disallowed?: { [x: string]: (...)[] };
};
sign?: boolean;
storeQueries?: boolean;
synchronous?: boolean;
tasks: (
| {
endPoint?: | "commit"
| "all"
| "clear"
| "delete"
| "get"
| "insert";
input?: string
| boolean
| (...)[];
mod: string;
required?: boolean;
}
| {
endPoint?: "divine";
input?: string
| boolean
| (...)[];
mod: string;
required?: boolean;
}
| {
endPoint?: "observe";
input?: string
| boolean
| (...)[];
mod: string;
required?: boolean;
}
| {
endPoint?: string;
input?: string
| boolean
| (...)[];
mod: string;
required?: boolean;
}
)[];
throwErrors?: boolean;
timestamp?: boolean;
},
>;
ephemeralQueryAccountEnabled?: boolean;
moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
},
SentinelModuleEventData<
Module<
BaseParamsFields & {
account?: AccountInstance
| "random";
additionalSigners?: AccountInstance[];
addToResolvers?: boolean;
allowNameResolution?: boolean;
config: DeepRestrictToStringKeys<
{
allowedQueries?: string[];
archiving?: { archivists?: (...)
| (...); queries?: (...) | (...) };
archivist?: string;
consoleLogger?: any;
labels?: { [x: string]: (...) | (...) };
name?: string;
paging?: { [x: string]: { size?: ... } };
retry?: {
backoff?: (...) | (...);
interval?: (...) | (...);
retries?: (...) | (...);
};
schema: string;
security?: {
allowAnonymous?: (...)
| (...)
| (...);
allowed?: (...) | (...);
disallowed?: (...) | (...);
};
sign?: boolean;
storeQueries?: boolean;
timestamp?: boolean;
},
>;
ephemeralQueryAccountEnabled?: boolean;
moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
},
>,
>,
>,
>,
config?: TypeCheckConfig,
): TType Type Parameters
- TType extends SentinelModule<
BaseParamsFields & {
account?: AccountInstance
| "random";
additionalSigners?: AccountInstance[];
addToResolvers?: boolean;
allowNameResolution?: boolean;
config: DeepRestrictToStringKeys<
{
allowedQueries?: string[];
archiving?: { archivists?: string[]; queries?: string[] };
archivist?: string;
automations?: (
| {
end?: number;
frequency?: number;
frequencyUnits?: "second"
| "minute"
| "hour"
| "day";
remaining?: number;
schema: "network.xyo.automation";
start: number;
type: "interval";
}
| {
end?: number;
frequency?: number;
frequencyUnits?: "second"
| "minute"
| "hour"
| "day";
remaining?: number;
schema: "network.xyo.automation.interval";
start: number;
type: "interval";
}
| {
end?: number;
frequency?: number;
frequencyUnits?: "second"
| "minute"
| "hour"
| "day";
remaining?: number;
schema: "network.xyo.automation.event";
start: number;
type: "interval";
}
| { schema: "network.xyo.automation"; type: "event" }
| { schema: "network.xyo.automation.interval"; type: "event" }
| { schema: "network.xyo.automation.event"; type: "event" }
)[];
consoleLogger?: any;
labels?: { [x: string]: undefined | string };
name?: string;
paging?: { [x: string]: { size?: number } };
retry?: { backoff?: number; interval?: number; retries?: number };
schema: string;
security?: {
allowAnonymous?: boolean;
allowed?: { [x: string]: ((...) | (...))[] };
disallowed?: { [x: string]: Lowercase<(...)>[] };
};
sign?: boolean;
storeQueries?: boolean;
synchronous?: boolean;
tasks: (
| {
endPoint?: "commit"
| "all"
| "clear"
| "delete"
| "get"
| "insert";
input?: string | boolean | string[];
mod: string;
required?: boolean;
}
| {
endPoint?: "divine";
input?: string
| boolean
| string[];
mod: string;
required?: boolean;
}
| {
endPoint?: "observe";
input?: string
| boolean
| string[];
mod: string;
required?: boolean;
}
| {
endPoint?: string;
input?: string
| boolean
| string[];
mod: string;
required?: boolean;
}
)[];
throwErrors?: boolean;
timestamp?: boolean;
},
>;
ephemeralQueryAccountEnabled?: boolean;
moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
},
SentinelModuleEventData<
Module<
BaseParamsFields & {
account?: AccountInstance
| "random";
additionalSigners?: AccountInstance[];
addToResolvers?: boolean;
allowNameResolution?: boolean;
config: DeepRestrictToStringKeys<
{
allowedQueries?: string[];
archiving?: { archivists?: (...)[]; queries?: (...)[] };
archivist?: string;
consoleLogger?: any;
labels?: { [x: string]: undefined | string };
name?: string;
paging?: { [x: string]: { size?: (...) | (...) } };
retry?: { backoff?: number; interval?: number; retries?: number };
schema: string;
security?: {
allowAnonymous?: boolean;
allowed?: { [x: ...]: ... };
disallowed?: { [x: ...]: ... };
};
sign?: boolean;
storeQueries?: boolean;
timestamp?: boolean;
},
>;
ephemeralQueryAccountEnabled?: boolean;
moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
},
>,
>,
>
Parameters
- value: AnyNonPromise
- assert: StringOrAlertFunction<
SentinelModule<
BaseParamsFields & {
account?: AccountInstance
| "random";
additionalSigners?: AccountInstance[];
addToResolvers?: boolean;
allowNameResolution?: boolean;
config: DeepRestrictToStringKeys<
{
allowedQueries?: string[];
archiving?: { archivists?: string[]; queries?: string[] };
archivist?: string;
automations?: (
| {
end?: (...)
| (...);
frequency?: (...) | (...);
frequencyUnits?: (...) | (...) | (...) | (...) | (...);
remaining?: (...) | (...);
schema: "network.xyo.automation";
start: number;
type: "interval";
}
| {
end?: (...)
| (...);
frequency?: (...) | (...);
frequencyUnits?: (...) | (...) | (...) | (...) | (...);
remaining?: (...) | (...);
schema: "network.xyo.automation.interval";
start: number;
type: "interval";
}
| {
end?: (...)
| (...);
frequency?: (...) | (...);
frequencyUnits?: (...) | (...) | (...) | (...) | (...);
remaining?: (...) | (...);
schema: "network.xyo.automation.event";
start: number;
type: "interval";
}
| { schema: "network.xyo.automation"; type: "event" }
| { schema: "network.xyo.automation.interval"; type: "event" }
| { schema: "network.xyo.automation.event"; type: "event" }
)[];
consoleLogger?: any;
labels?: { [x: string]: undefined | string };
name?: string;
paging?: { [x: string]: { size?: number } };
retry?: { backoff?: number; interval?: number; retries?: number };
schema: string;
security?: {
allowAnonymous?: boolean;
allowed?: { [x: string]: (...)[] };
disallowed?: { [x: string]: (...)[] };
};
sign?: boolean;
storeQueries?: boolean;
synchronous?: boolean;
tasks: (
| {
endPoint?: | "commit"
| "all"
| "clear"
| "delete"
| "get"
| "insert";
input?: string
| boolean
| (...)[];
mod: string;
required?: boolean;
}
| {
endPoint?: "divine";
input?: string
| boolean
| (...)[];
mod: string;
required?: boolean;
}
| {
endPoint?: "observe";
input?: string
| boolean
| (...)[];
mod: string;
required?: boolean;
}
| {
endPoint?: string;
input?: string
| boolean
| (...)[];
mod: string;
required?: boolean;
}
)[];
throwErrors?: boolean;
timestamp?: boolean;
},
>;
ephemeralQueryAccountEnabled?: boolean;
moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
},
SentinelModuleEventData<
Module<
BaseParamsFields & {
account?: AccountInstance
| "random";
additionalSigners?: AccountInstance[];
addToResolvers?: boolean;
allowNameResolution?: boolean;
config: DeepRestrictToStringKeys<
{
allowedQueries?: string[];
archiving?: { archivists?: (...)
| (...); queries?: (...) | (...) };
archivist?: string;
consoleLogger?: any;
labels?: { [x: string]: (...) | (...) };
name?: string;
paging?: { [x: string]: { size?: ... } };
retry?: {
backoff?: (...) | (...);
interval?: (...) | (...);
retries?: (...) | (...);
};
schema: string;
security?: {
allowAnonymous?: (...)
| (...)
| (...);
allowed?: (...) | (...);
disallowed?: (...) | (...);
};
sign?: boolean;
storeQueries?: boolean;
timestamp?: boolean;
},
>;
ephemeralQueryAccountEnabled?: boolean;
moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
},
>,
>,
>,
> Optionalconfig: TypeCheckConfig