Class TableQueryFields

Hierarchy

Map<string, string | number | boolean | number[] | string[]>
- TableQueryFields

Index

Constructors

Properties

Methods

[iterator] clear delete entries forEach get getBool getInt getNumber getNumberArr getString getStringArr getStringOption has keys set validateFields values validate

Constructors

constructor

new TableQueryFields(
    entries?:
        | readonly (
            readonly [string, string | number | boolean | string[] | number[]]
        )[]
        | null,
): TableQueryFields
Parameters
- Optionalentries:
      | readonly (
          readonly [string, string | number | boolean | string[] | number[]]
      )[]
      | null
Returns TableQueryFields
Inherited from Map< string, string | number | boolean | number[] | string[] >.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:51
new TableQueryFields(
    iterable?:
        | Iterable<
            readonly [string, string | number | boolean | string[] | number[]],
            any,
            any,
        >
        | null,
): TableQueryFields
Parameters
- Optionaliterable:
      | Iterable<
          readonly [string, string | number | boolean | string[] | number[]],
          any,
          any,
      >
      | null
Returns TableQueryFields
Inherited from Map< string, string | number | boolean | number[] | string[] >.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:50
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:51

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Readonly`size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly`[species]

"[species]": MapConstructor

Methods

[iterator]

"[iterator]"(): MapIterator<
[string, string | number | boolean | string[] | number[]],
>
Returns an iterable of entries in the map.

Returns MapIterator<[string, string | number | boolean | string[] | number[]]>
Inherited from Map.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:141

clear

clear(): void
Removes all elements from the Map.

Returns void
Inherited from Map.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:21

delete

delete(key: string): boolean
Parameters
- key: string
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Inherited from Map.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:25

entries

entries(): MapIterator<
[string, string | number | boolean | string[] | number[]],
>
Returns an iterable of key, value pairs for every entry in the map.

Returns MapIterator<[string, string | number | boolean | string[] | number[]]>
Inherited from Map.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:146

forEach

forEach(
    callbackfn: (
        value: string | number | boolean | string[] | number[],
        key: string,
        map: Map<string, string | number | boolean | string[] | number[]>,
    ) => void,
    thisArg?: any,
): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: (
      value: string | number | boolean | string[] | number[],
      key: string,
      map: Map<string, string | number | boolean | string[] | number[]>,
  ) => void
- OptionalthisArg: any
Returns void
Inherited from Map.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:29

get

get(key: string): string | number | boolean | string[] | number[] | undefined
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
Parameters
- key: string
Returns string | number | boolean | string[] | number[] | undefined
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Inherited from Map.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:34

getBool

getBool(key: string): boolean | null | undefined
Parameters
- key: string
Returns boolean | null | undefined
- Defined in src/classes/TableQueryFields.ts:34

getInt

getInt(key: string): number | null | undefined
Parameters
- key: string
Returns number | null | undefined
- Defined in src/classes/TableQueryFields.ts:28

getNumber

getNumber(key: string): number | null | undefined
Parameters
- key: string
Returns number | null | undefined
- Defined in src/classes/TableQueryFields.ts:22

getNumberArr

getNumberArr(key: string): number[] | null | undefined
Parameters
- key: string
Returns number[] | null | undefined
- Defined in src/classes/TableQueryFields.ts:40

getString

getString(key: string): string | null | undefined
Parameters
- key: string
Returns string | null | undefined
- Defined in src/classes/TableQueryFields.ts:7

getStringArr

getStringArr(key: string): string[] | null | undefined
Parameters
- key: string
Returns string[] | null | undefined
- Defined in src/classes/TableQueryFields.ts:48

getStringOption

getStringOption(key: string, ...options: string[]): string | null | undefined
Parameters
- key: string
- ...options: string[]
Returns string | null | undefined
- Defined in src/classes/TableQueryFields.ts:13

has

has(key: string): boolean
Parameters
- key: string
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Inherited from Map.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:38

keys

keys(): MapIterator<string>
Returns an iterable of keys in the map

Returns MapIterator<string>
Inherited from Map.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:151

set

set(key: string, value: string | number | boolean | string[] | number[]): this
Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
Parameters
- key: string
- value: string | number | boolean | string[] | number[]
Returns this
Inherited from Map.set
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:42

validateFields

validateFields<T extends object>(
    fc: (q: this) => T,
): {
    error: Partial<ErrorType> | null;
    fields: { [K in string | number | symbol]: Exclude<T[K], null> };
}
Type Parameters
- T extends object
Parameters
- fc: (q: this) => T
Returns {
error: Partial<ErrorType> | null;
fields: { [K in string | number | symbol]: Exclude<T[K], null> };
}
- Defined in src/classes/TableQueryFields.ts:56

values

values(): MapIterator<string | number | boolean | string[] | number[]>
Returns an iterable of values in the map

Returns MapIterator<string | number | boolean | string[] | number[]>
Inherited from Map.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:156

`Static`validate

validate<T extends object>(
    obj: T,
): {
    error: Partial<ErrorType> | null;
    fields: { [K in string | number | symbol]: Exclude<T[K], null> };
}
Type Parameters
- T extends object
Parameters
- obj: T
Returns {
error: Partial<ErrorType> | null;
fields: { [K in string | number | symbol]: Exclude<T[K], null> };
}
- Defined in src/classes/TableQueryFields.ts:60

Class TableQueryFields

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TableQueryFields

Parameters

Returns TableQueryFields

Properties

Readonly[toStringTag]

Readonlysize

Returns

Static Readonly[species]

Methods

[iterator]

Returns MapIterator<[string, string | number | boolean | string[] | number[]]>

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns MapIterator<[string, string | number | boolean | string[] | number[]]>

forEach

Parameters

Returns void

get

Parameters

Returns string | number | boolean | string[] | number[] | undefined

getBool

Parameters

Returns boolean | null | undefined

getInt

Parameters

Returns number | null | undefined

getNumber

Parameters

Returns number | null | undefined

getNumberArr

Parameters

Returns number[] | null | undefined

getString

Parameters

Returns string | null | undefined

getStringArr

Parameters

Returns string[] | null | undefined

getStringOption

Parameters

Returns string | null | undefined

has

Parameters

Returns boolean

keys

Returns MapIterator<string>

set

Parameters

Returns this

validateFields

Type Parameters

Parameters

Returns { error: Partial<ErrorType> | null; fields: { [K in string | number | symbol]: Exclude<T[K], null> };}

values

Returns MapIterator<string | number | boolean | string[] | number[]>

Staticvalidate

Type Parameters

Parameters

Returns { error: Partial<ErrorType> | null; fields: { [K in string | number | symbol]: Exclude<T[K], null> };}

Settings

On This Page

`Readonly`[toStringTag]

`Readonly`size

`Static` `Readonly`[species]

Returns {
error: Partial<ErrorType> | null;
fields: { [K in string | number | symbol]: Exclude<T[K], null> };
}

`Static`validate

Returns {
error: Partial<ErrorType> | null;
fields: { [K in string | number | symbol]: Exclude<T[K], null> };
}