Browse Source

Complete documentation

Document previously undocumented classes and functions.
master
TheoryOfNekomata 1 year ago
parent
commit
1e914ad467
1 changed files with 14 additions and 0 deletions
  1. +14
    -0
      src/index.ts

+ 14
- 0
src/index.ts View File

@@ -287,6 +287,11 @@ const getInputCheckboxFieldValue = (
return null; return null;
}; };


/**
* Parses values that can be candidates for a Boolean value.
* @param value - A value.
* @returns The corresponding Boolean value.
*/
const parseBooleanValues = (value: unknown) => { const parseBooleanValues = (value: unknown) => {
if (typeof value === 'boolean') { if (typeof value === 'boolean') {
return value; return value;
@@ -630,9 +635,18 @@ type GetInputTextualFieldValueOptions = {
includeDirectionality?: true; includeDirectionality?: true;
} }


/**
* Class for overloading a string with directionality information.
*/
class TextualValueString extends String { class TextualValueString extends String {
/**
* The form name of the directionality value.
*/
readonly dirName: string; readonly dirName: string;


/**
* The directionality value.
*/
readonly dir: string; readonly dir: string;


constructor(value: unknown, dirName: string, dir: string) { constructor(value: unknown, dirName: string, dir: string) {


Loading…
Cancel
Save