Start9/start-sdk
2
0
Fork 0
mirror of https://github.com/Start9Labs/start-sdk.git synced 2026-03-26 10:21:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: Add some documentation

Browse Source
This commit is contained in:
BluJ
2022-12-09 16:22:12 -07:00
parent 5e60e754ed
commit 3988d7ce8b
1 changed files with 24 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
utils/propertiesMatcher.ts
View File

@@ -1,4 +1,5 @@
import { matches } from "../dependencies.ts";
import { ConfigSpec, ValueSpecAny } from "../types.ts";
type TypeBoolean = "boolean";
type TypeString = "string";
@@ -174,7 +175,16 @@ function defaultNullable<A>(parser: matches.Parser<unknown, A>, value: unknown)
if (matchNullable.test(value)) return parser.optional();
return parser;
}
export function guardAll<A>(value: A): matches.Parser<unknown, GuardAll<A>> {
/**
* ConfigSpec: Tells the UI how to ask for information, verification, and will send the service a config in a shape via the spec.
* ValueSpecAny: This is any of the values in a config spec.
*
* Use this when we want to convert a value spec any into a parser for what a config will look like
* @param value
* @returns
*/
export function guardAll<A extends ValueSpecAny>(value: A): matches.Parser<unknown, GuardAll<A>> {
if (!isType.test(value)) {
// deno-lint-ignore no-explicit-any
return matches.unknown as any;
@@ -209,7 +219,10 @@ export function guardAll<A>(value: A): matches.Parser<unknown, GuardAll<A>> {
const subtype = matchSubType.unsafeCast(value).subtype;
return defaultNullable(
matches.arrayOf(guardAll({ type: subtype, ...spec })).validate((x) => rangeValidate(x.length), "valid length"),
matches
// deno-lint-ignore no-explicit-any
.arrayOf(guardAll({ type: subtype, ...spec } as any))
.validate((x) => rangeValidate(x.length), "valid length"),
value
// deno-lint-ignore no-explicit-any
) as any;
@@ -242,7 +255,15 @@ export function guardAll<A>(value: A): matches.Parser<unknown, GuardAll<A>> {
// deno-lint-ignore no-explicit-any
return matches.unknown as any;
}
export function typeFromProps<A>(valueDictionary: A): matches.Parser<unknown, TypeFromProps<A>> {
/**
* ConfigSpec: Tells the UI how to ask for information, verification, and will send the service a config in a shape via the spec.
* ValueSpecAny: This is any of the values in a config spec.
*
* Use this when we want to convert a config spec into a parser for what a config will look like
* @param valueDictionary
* @returns
*/
export function typeFromProps<A extends ConfigSpec>(valueDictionary: A): matches.Parser<unknown, TypeFromProps<A>> {
// deno-lint-ignore no-explicit-any
if (!recordString.test(valueDictionary)) return matches.unknown as any;
return matches.shape(