@wtf/release-docs 9.0.2 → 10.0.0

package/api/@wtf/{release-system → release}/posix/functions/dirnameOf.md

@@ -2,13 +2,13 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-system/posix](../README.md) / dirnameOf
+[Release trains](../../../../README.md) / [@wtf/release/posix](../README.md) / dirnameOf
 
 # Function: dirnameOf()
 
 > **dirnameOf**(`path`): `string`
 
-Defined in: [packages/release-system/src/posix.ts:53](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-system/src/posix.ts#L53)
+Defined in: [packages/release/src/posix.ts:53](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/posix.ts#L53)
 
 The folder a path is in: `packages/a` of `packages/a/package.json`, and `.` of a bare name.
 

package/api/@wtf/{release-system → release}/posix/functions/joinPath.md

@@ -2,13 +2,13 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-system/posix](../README.md) / joinPath
+[Release trains](../../../../README.md) / [@wtf/release/posix](../README.md) / joinPath
 
 # Function: joinPath()
 
 > **joinPath**(...`parts`): `string`
 
-Defined in: [packages/release-system/src/posix.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-system/src/posix.ts#L24)
+Defined in: [packages/release/src/posix.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/posix.ts#L24)
 
 The parts of a path with `/` between them, each `.` dropped and each `..` taking the part before
 it: `/repo/packages/a` of `/repo` and `./packages/b/../a`; `.` of nothing.

package/api/@wtf/{release-system → release}/posix/functions/relativePath.md

@@ -2,13 +2,13 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-system/posix](../README.md) / relativePath
+[Release trains](../../../../README.md) / [@wtf/release/posix](../README.md) / relativePath
 
 # Function: relativePath()
 
 > **relativePath**(`from`, `to`): `string`
 
-Defined in: [packages/release-system/src/posix.ts:75](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-system/src/posix.ts#L75)
+Defined in: [packages/release/src/posix.ts:75](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/posix.ts#L75)
 
 The path `to` from the folder `from`, both absolute: `packages/a` of `/repo` and
 `/repo/packages/a`, and the empty string of the folder itself.

package/api/@wtf/{release-system → release}/posix/functions/resolvePath.md

@@ -2,13 +2,13 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-system/posix](../README.md) / resolvePath
+[Release trains](../../../../README.md) / [@wtf/release/posix](../README.md) / resolvePath
 
 # Function: resolvePath()
 
 > **resolvePath**(`from`, `path`): `string`
 
-Defined in: [packages/release-system/src/posix.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-system/src/posix.ts#L44)
+Defined in: [packages/release/src/posix.ts:44](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/posix.ts#L44)
 
 The path `path` of the folder `from`: itself when it is absolute, else the two joined.
 
@@ -18,7 +18,7 @@ The path `path` of the folder `from`: itself when it is absolute, else the two j
 
 `string`
 
-The folder a relative `path` is of, absolute as the working folder of a system.
+The folder a relative `path` is of, absolute as the working folder of a platform.
 
 ### path
 

package/api/@wtf/release/process/README.md

@@ -0,0 +1,30 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / @wtf/release/process
+
+# @wtf/release/process
+
+A program of a repo, run to its end: [run](functions/run.md), in the folder of the repo, the working folder of
+the platform, or in a folder of it, by the platform's `spawn`, as `exec` of
+`@wtf/platform/process` runs one, and [envOf](functions/envOf.md), the environment of a program, of the
+platform's and the variables a caller sets.
+
+```ts
+import type { RepoPlatform } from '@wtf/release'
+import { run } from '@wtf/release/process'
+
+export const headOf = async (platform: RepoPlatform) =>
+  (await run(platform, 'git', ['rev-parse', 'HEAD'])).stdout.trim()
+```
+
+## Interfaces
+
+- [RunOptions](interfaces/RunOptions.md)
+- [RunResult](interfaces/RunResult.md)
+
+## Functions
+
+- [envOf](functions/envOf.md)
+- [run](functions/run.md)

package/api/@wtf/release/process/functions/envOf.md

@@ -0,0 +1,34 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release/process](../README.md) / envOf
+
+# Function: envOf()
+
+> **envOf**(`env`, `set?`): `Record`\<`string`, `string`\>
+
+Defined in: [packages/release/src/process.ts:53](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/process.ts#L53)
+
+The environment of a program: the variables of `env` that are set, and each of `set` over them,
+one of `undefined` left out.
+
+## Parameters
+
+### env
+
+`Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
+
+The environment, as the platform's `env`.
+
+### set?
+
+`Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\> = `{}`
+
+The variables to set over it, or to leave out of `undefined`: none by default.
+
+## Returns
+
+`Record`\<`string`, `string`\>
+
+The variables, each of a value.

package/api/@wtf/release/process/functions/run.md

@@ -0,0 +1,48 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release/process](../README.md) / run
+
+# Function: run()
+
+> **run**(`platform`, `command`, `args`, `options?`): `Promise`\<[`RunResult`](../interfaces/RunResult.md)\>
+
+Defined in: [packages/release/src/process.ts:76](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/process.ts#L76)
+
+Runs `command` with `args` to its end, in the folder of the repo, the platform's `dirs.cwd`, or
+in `cwd` of it, by the platform's `spawn`, and gives what it wrote, as text, and the code it
+exited with: a code other than 0 is no failure of its own, which the caller decides. A command
+that cannot start rejects with the `SystemError` of the platform, `NotFound` of one not there.
+
+## Parameters
+
+### platform
+
+[`RepoPlatform`](../../type-aliases/RepoPlatform.md)
+
+The platform the program runs by, of the folder of the repo.
+
+### command
+
+`string`
+
+The command, by its name on the path of the environment or by its path.
+
+### args
+
+readonly `string`[]
+
+The arguments of the command, each as it is, of no shell.
+
+### options?
+
+[`RunOptions`](../interfaces/RunOptions.md) = `{}`
+
+The folder it runs in, its environment and what it reads.
+
+## Returns
+
+`Promise`\<[`RunResult`](../interfaces/RunResult.md)\>
+
+What it wrote, on its stdout and its stderr, as UTF-8, and its exit code.

package/api/@wtf/release/process/interfaces/RunOptions.md

@@ -0,0 +1,52 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release/process](../README.md) / RunOptions
+
+# Interface: RunOptions
+
+Defined in: [packages/release/src/process.ts:31](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/process.ts#L31)
+
+How [run](../functions/run.md) runs a program: its folder, its environment, and what it reads.
+
+## Properties
+
+### cwd?
+
+> `readonly` `optional` **cwd?**: `string`
+
+Defined in: [packages/release/src/process.ts:36](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/process.ts#L36)
+
+The folder it runs in, from the folder of the repo, or absolute, as a temporary folder: the
+folder of the repo by default.
+
+***
+
+### env?
+
+> `readonly` `optional` **env?**: `Readonly`\<`Record`\<`string`, `string` \| `undefined`\>\>
+
+Defined in: [packages/release/src/process.ts:38](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/process.ts#L38)
+
+Its environment, whole: the platform's `env` by default, as [envOf](../functions/envOf.md) makes one.
+
+***
+
+### input?
+
+> `readonly` `optional` **input?**: `string`
+
+Defined in: [packages/release/src/process.ts:40](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/process.ts#L40)
+
+What it reads on its stdin: nothing by default.
+
+***
+
+### signal?
+
+> `readonly` `optional` **signal?**: `AbortSignal`
+
+Defined in: [packages/release/src/process.ts:42](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/process.ts#L42)
+
+What ends it, aborted: none by default.

package/api/@wtf/release/process/interfaces/RunResult.md

@@ -0,0 +1,35 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release/process](../README.md) / RunResult
+
+# Interface: RunResult
+
+Defined in: [packages/release/src/process.ts:24](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/process.ts#L24)
+
+What a program [run](../functions/run.md) ran wrote, as text, and the code it exited with.
+
+## Properties
+
+### code
+
+> `readonly` **code**: `number`
+
+Defined in: [packages/release/src/process.ts:27](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/process.ts#L27)
+
+***
+
+### stderr
+
+> `readonly` **stderr**: `string`
+
+Defined in: [packages/release/src/process.ts:26](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/process.ts#L26)
+
+***
+
+### stdout
+
+> `readonly` **stdout**: `string`
+
+Defined in: [packages/release/src/process.ts:25](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/process.ts#L25)

package/api/@wtf/release/type-aliases/ReleasePlatform.md

@@ -0,0 +1,22 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/release](../README.md) / ReleasePlatform
+
+# Type Alias: ReleasePlatform
+
+> **ReleasePlatform** = `Pick`\<`ProcessPlatform`, `"spawn"` \| `"env"` \| `"fetch"` \| `"path"` \| `"navigator"` \| `"crypto"`\> & `object`
+
+Defined in: [packages/release/src/index.ts:63](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/index.ts#L63)
+
+What a release runs by: a [RepoPlatform](RepoPlatform.md), and `fetch`; and what makes a temporary folder
+outside the repo, as `tempFolder` of `@wtf/platform-fs/files` does, where a release stages what it
+packs: the platform's storage, its paths, its temporary folder, `dirs.temp`, and
+`crypto.randomUUID`. A `ProcessPlatform` of `@wtf/platform` is one.
+
+## Type Declaration
+
+### dirs
+
+> `readonly` **dirs**: `Pick`\<`Dirs`, `"cwd"` \| `"temp"`\>

package/api/@wtf/release/type-aliases/RepoPlatform.md

@@ -0,0 +1,21 @@
+[**Release trains**](../../../README.md)
+
+***
+
+[Release trains](../../../README.md) / [@wtf/release](../README.md) / RepoPlatform
+
+# Type Alias: RepoPlatform
+
+> **RepoPlatform** = `Pick`\<`ProcessPlatform`, `"spawn"` \| `"env"`\> & `object`
+
+Defined in: [packages/release/src/index.ts:53](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/index.ts#L53)
+
+What runs the programs of a repo, as git: the platform's `spawn` and the environment a program is
+given, `env`; and its working folder, `dirs.cwd`, the folder of the repo, which each program runs
+in, and a relative folder of a program is of.
+
+## Type Declaration
+
+### dirs
+
+> `readonly` **dirs**: `Pick`\<`Dirs`, `"cwd"`\>

package/api/@wtf/{release-system → release}/validator/README.md

@@ -2,9 +2,9 @@
 
 ***
 
-[Release trains](../../../README.md) / @wtf/release-system/validator
+[Release trains](../../../README.md) / @wtf/release/validator
 
-# @wtf/release-system/validator
+# @wtf/release/validator
 
 Validators of options: each is a Standard Schema (`StandardSchemaV1` of `@standard-schema/spec`),
 which any consumer of the standard validates by, and a Standard JSON Schema
@@ -23,8 +23,8 @@ A validator checks what JSON Schema can say, and its JSON Schema says the same;
 the shape it refines.
 
 ```ts
-import { ReleaseError } from '@wtf/release-system/errors'
-import { errorsOf, objectOf, stringOf } from '@wtf/release-system/validator'
+import { ReleaseError } from '@wtf/release/errors'
+import { errorsOf, objectOf, stringOf } from '@wtf/release/validator'
 
 class DeployError extends ReleaseError {}
 
@@ -58,13 +58,14 @@ errorsOf(options, { target: '' }, DeployError) // [DeployError EOPTIONS of targe
 - [errorOf](functions/errorOf.md)
 - [errorsOf](functions/errorsOf.md)
 - [exclusive](functions/exclusive.md)
+- [issueOf](functions/issueOf.md)
 - [issuesOf](functions/issuesOf.md)
 - [objectOf](functions/objectOf.md)
 - [oneOf](functions/oneOf.md)
 - [orFunction](functions/orFunction.md)
 - [pathText](functions/pathText.md)
-- [pluginEntriesOf](functions/pluginEntriesOf.md)
 - [recordOf](functions/recordOf.md)
 - [refined](functions/refined.md)
 - [stringOf](functions/stringOf.md)
 - [tupleOf](functions/tupleOf.md)
+- [validatorOf](functions/validatorOf.md)

package/api/@wtf/{release-system → release}/validator/functions/allOf.md

@@ -2,13 +2,13 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-system/validator](../README.md) / allOf
+[Release trains](../../../../README.md) / [@wtf/release/validator](../README.md) / allOf
 
 # Function: allOf()
 
 > **allOf**\<`A`, `B`\>(`base`, `more`): [`Validator`](../interfaces/Validator.md)\<`A` & `B`\>
 
-Defined in: [packages/release-system/src/validator.ts:487](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-system/src/validator.ts#L487)
+Defined in: [packages/release/src/validator.ts:508](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/validator.ts#L508)
 
 A validator of what both `base` and `more` check, as the options of a plugin of the options of
 the root and its own: an object of the properties of both, each of either's required.

package/api/@wtf/{release-system → release}/validator/functions/anyObject.md

@@ -2,15 +2,15 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-system/validator](../README.md) / anyObject
+[Release trains](../../../../README.md) / [@wtf/release/validator](../README.md) / anyObject
 
 # Function: anyObject()
 
 > **anyObject**(`options?`): [`Validator`](../interfaces/Validator.md)\<`object`\>
 
-Defined in: [packages/release-system/src/validator.ts:214](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-system/src/validator.ts#L214)
+Defined in: [packages/release/src/validator.ts:235](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/validator.ts#L235)
 
-A validator of any object, of no shape it checks, as a system or a publisher.
+A validator of any object, of no shape it checks, as a platform or a publisher.
 
 ## Parameters
 

package/api/@wtf/{release-system → release}/validator/functions/anyOf.md

@@ -2,13 +2,13 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-system/validator](../README.md) / anyOf
+[Release trains](../../../../README.md) / [@wtf/release/validator](../README.md) / anyOf
 
 # Function: anyOf()
 
 > **anyOf**\<`T`\>(`validators`, `expected`, `options?`): [`Validator`](../interfaces/Validator.md)\<`T`\>
 
-Defined in: [packages/release-system/src/validator.ts:307](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-system/src/validator.ts#L307)
+Defined in: [packages/release/src/validator.ts:328](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/validator.ts#L328)
 
 A validator of a value of any of `validators`, tried in order.
 

package/api/@wtf/{release-system → release}/validator/functions/arrayOf.md

@@ -2,13 +2,13 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-system/validator](../README.md) / arrayOf
+[Release trains](../../../../README.md) / [@wtf/release/validator](../README.md) / arrayOf
 
 # Function: arrayOf()
 
 > **arrayOf**\<`T`\>(`item`, `options?`): [`Validator`](../interfaces/Validator.md)\<`T`[]\>
 
-Defined in: [packages/release-system/src/validator.ts:237](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-system/src/validator.ts#L237)
+Defined in: [packages/release/src/validator.ts:258](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/validator.ts#L258)
 
 A validator of an array, of each item of `item`, and of a least count of items.
 

package/api/@wtf/{release-system → release}/validator/functions/booleanOf.md

@@ -2,13 +2,13 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-system/validator](../README.md) / booleanOf
+[Release trains](../../../../README.md) / [@wtf/release/validator](../README.md) / booleanOf
 
 # Function: booleanOf()
 
 > **booleanOf**(`options?`): [`Validator`](../interfaces/Validator.md)\<`boolean`\>
 
-Defined in: [packages/release-system/src/validator.ts:183](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-system/src/validator.ts#L183)
+Defined in: [packages/release/src/validator.ts:204](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/validator.ts#L204)
 
 A validator of a boolean.
 

package/api/@wtf/{release-system → release}/validator/functions/errorOf.md

@@ -2,13 +2,13 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-system/validator](../README.md) / errorOf
+[Release trains](../../../../README.md) / [@wtf/release/validator](../README.md) / errorOf
 
 # Function: errorOf()
 
 > **errorOf**\<`E`\>(`found`, `as`): `E`
 
-Defined in: [packages/release-system/src/validator.ts:625](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-system/src/validator.ts#L625)
+Defined in: [packages/release/src/validator.ts:599](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/validator.ts#L599)
 
 The error of an issue, of its code, its message and its details, of the class `as`.
 

package/api/@wtf/{release-system → release}/validator/functions/errorsOf.md

@@ -2,13 +2,13 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-system/validator](../README.md) / errorsOf
+[Release trains](../../../../README.md) / [@wtf/release/validator](../README.md) / errorsOf
 
 # Function: errorsOf()
 
 > **errorsOf**\<`E`\>(`of`, `value`, `as`, `path?`): `E`[]
 
-Defined in: [packages/release-system/src/validator.ts:639](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-system/src/validator.ts#L639)
+Defined in: [packages/release/src/validator.ts:613](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/validator.ts#L613)
 
 The errors of the issues of `value` by the validator `of`, each of the class `as`, of the package
 that asks: none of a valid one.

package/api/@wtf/{release-system → release}/validator/functions/exclusive.md

@@ -2,13 +2,13 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-system/validator](../README.md) / exclusive
+[Release trains](../../../../README.md) / [@wtf/release/validator](../README.md) / exclusive
 
 # Function: exclusive()
 
 > **exclusive**\<`T`\>(`base`, `keys`, `options?`): [`Validator`](../interfaces/Validator.md)\<`T`\>
 
-Defined in: [packages/release-system/src/validator.ts:506](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-system/src/validator.ts#L506)
+Defined in: [packages/release/src/validator.ts:527](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/validator.ts#L527)
 
 A validator of `base`, of an object that has at most one of `keys`, as the options of an entry of
 one role of several: the issue of each key past the first it has, at that key. Its JSON Schema is

package/api/@wtf/release/validator/functions/issueOf.md

@@ -0,0 +1,45 @@
+[**Release trains**](../../../../README.md)
+
+***
+
+[Release trains](../../../../README.md) / [@wtf/release/validator](../README.md) / issueOf
+
+# Function: issueOf()
+
+> **issueOf**(`path`, `value`, `expected`, `options`): [`OptionIssue`](../interfaces/OptionIssue.md)
+
+Defined in: [packages/release/src/validator.ts:151](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/validator.ts#L151)
+
+The issue of `value` at `path`, by `options`, or of `expected`.
+
+## Parameters
+
+### path
+
+[`Path`](../type-aliases/Path.md)
+
+Where the value is in the options.
+
+### value
+
+`unknown`
+
+The value, as it is given: `undefined` of one that is missing.
+
+### expected
+
+`string`
+
+What the value is to be, as `a string`, which the message says.
+
+### options
+
+[`IssueOptions`](../interfaces/IssueOptions.md)
+
+The code, the message and the details, each in place of its default.
+
+## Returns
+
+[`OptionIssue`](../interfaces/OptionIssue.md)
+
+The issue.

package/api/@wtf/{release-system → release}/validator/functions/issuesOf.md

@@ -2,13 +2,13 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-system/validator](../README.md) / issuesOf
+[Release trains](../../../../README.md) / [@wtf/release/validator](../README.md) / issuesOf
 
 # Function: issuesOf()
 
 > **issuesOf**(`of`, `value`, `path?`): [`OptionIssue`](../interfaces/OptionIssue.md)[]
 
-Defined in: [packages/release-system/src/validator.ts:613](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-system/src/validator.ts#L613)
+Defined in: [packages/release/src/validator.ts:587](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/validator.ts#L587)
 
 The issues of `value` by the validator `of`, at `path`: none of a valid one.
 

package/api/@wtf/{release-system → release}/validator/functions/objectOf.md

@@ -2,13 +2,13 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-system/validator](../README.md) / objectOf
+[Release trains](../../../../README.md) / [@wtf/release/validator](../README.md) / objectOf
 
 # Function: objectOf()
 
 > **objectOf**\<`T`\>(`properties`, `options?`): [`Validator`](../interfaces/Validator.md)\<`T`\>
 
-Defined in: [packages/release-system/src/validator.ts:352](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-system/src/validator.ts#L352)
+Defined in: [packages/release/src/validator.ts:373](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/validator.ts#L373)
 
 A validator of an object of `properties`, each of its validator, each required unless it is
 optional; of no property but these, where it is `closed`. A property that is `undefined` is

package/api/@wtf/{release-system → release}/validator/functions/oneOf.md

@@ -2,13 +2,13 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-system/validator](../README.md) / oneOf
+[Release trains](../../../../README.md) / [@wtf/release/validator](../README.md) / oneOf
 
 # Function: oneOf()
 
 > **oneOf**\<`T`\>(`values`, `options?`): [`Validator`](../interfaces/Validator.md)\<`T`\>
 
-Defined in: [packages/release-system/src/validator.ts:197](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-system/src/validator.ts#L197)
+Defined in: [packages/release/src/validator.ts:218](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/validator.ts#L218)
 
 A validator of one of `values`, each a string, a number or a boolean.
 

package/api/@wtf/{release-system → release}/validator/functions/orFunction.md

@@ -2,13 +2,13 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-system/validator](../README.md) / orFunction
+[Release trains](../../../../README.md) / [@wtf/release/validator](../README.md) / orFunction
 
 # Function: orFunction()
 
 > **orFunction**\<`T`\>(`base`): [`Validator`](../interfaces/Validator.md)\<`T` \| ((...`args`) => `unknown`)\>
 
-Defined in: [packages/release-system/src/validator.ts:552](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-system/src/validator.ts#L552)
+Defined in: [packages/release/src/validator.ts:573](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/validator.ts#L573)
 
 A validator of a value of `base`, or of a function, which a config of JavaScript gives and JSON
 cannot write: its JSON Schema is `base`'s, as a JSON config takes no function.

package/api/@wtf/{release-system → release}/validator/functions/pathText.md

@@ -2,13 +2,13 @@
 
 ***
 
-[Release trains](../../../../README.md) / [@wtf/release-system/validator](../README.md) / pathText
+[Release trains](../../../../README.md) / [@wtf/release/validator](../README.md) / pathText
 
 # Function: pathText()
 
 > **pathText**(`path`): `string`
 
-Defined in: [packages/release-system/src/validator.ts:98](https://gitlab.com/wetryfun/release/release/-/blob/3b0e2c3c91b521977d05b801e2297d0df9e52834/packages/release-system/src/validator.ts#L98)
+Defined in: [packages/release/src/validator.ts:98](https://gitlab.com/wetryfun/release/release/-/blob/27c0c9bead8eea4a721e18a0cbd2724080f82e69/packages/release/src/validator.ts#L98)
 
 `path`, as a reader writes it: `trains.core.paths[0]`, or `the options` of none.