Start9/start-sdk
2
0
Fork 0
mirror of https://github.com/Start9Labs/start-sdk.git synced 2026-04-01 21:13:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: Update docs and get the test working

Browse Source
This commit is contained in:
BluJ
2023-04-03 10:19:04 -06:00
parent ce0c06c5e7
commit 24e2f1c8dd
6 changed files with 107 additions and 552 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
lib/config/builder/value.ts
View File

@@ -21,18 +21,17 @@ import { DefaultString } from "../config-types";
* Keep an eye out for another config builder types as params.
* Note, usually this is going to be used in a `Config` {@link Config} builder.
```ts
Value.string({
name: "Name of This Value",
description: "Going to be what the description is in the FE, hover over",
warning: "What the warning is going to be on warning situations",
default: null,
nullable: false,
masked: null, // If there is a masked, then the value is going to be masked in the FE, like a password
placeholder: null, // If there is a placeholder, then the value is going to be masked in the FE, like a password
pattern: null, // A regex pattern to validate the value
patternDescription: null,
textarea: null
})
const username = Value.string({
name: "Username",
default: "bitcoin",
description: "The username for connecting to Bitcoin over RPC.",
warning: null,
required: true,
masked: true,
placeholder: null,
pattern: "^[a-zA-Z0-9_]+$",
patternDescription: "Must be alphanumeric (can contain underscore).",
});
```
*/
export class Value<A extends ValueSpec> extends IBuilder<A> {