Class Guard

Index

Constructors

Methods

number positiveNumber integer positiveInteger pointArray

Constructors

constructor

new Guard(): Guard
Returns Guard

Methods

`Static`number

number(name: string, val: any, el: Element | null): number | undefined
Checks for a valid number
Parameters
- name: string
  The name of the attribute for error messages
- val: any
  The value to check
- el: Element | null
  The element where the attribute is defined, for error context
Returns number | undefined

`Static`positiveNumber

positiveNumber(name: string, val: any, el: Element | null): number | undefined
Checks for a valid positive number >= 0
Parameters
- name: string
  The name of the attribute for error messages
- val: any
  The value to check
- el: Element | null
  The element where the attribute is defined, for error context
Returns number | undefined

`Static`integer

integer(name: string, val: any, el: Element | null): number | undefined
Checks for a valid integer
Parameters
- name: string
  The name of the attribute for error messages
- val: any
  The value to check
- el: Element | null
  The element where the attribute is defined, for error context
Returns number | undefined

`Static`positiveInteger

positiveInteger(name: string, val: any, el: Element | null): number | undefined
Checks for a valid, positive integer >= 0
Parameters
- name: string
  The name of the attribute for error messages
- val: any
  The value to check
- el: Element | null
  The element where the attribute is defined, for error context
Returns number | undefined

`Static`pointArray

pointArray(
    val?: any,
    name?: string,
    minPoints?: number,
    el?: Element,
): [number, number][] | undefined
Checks for a non-empty array of points (required for polygons/polylines)
Parameters
- Optionalval: any
- Optionalname: string
- OptionalminPoints: number
- Optionalel: Element
Returns [number, number][] | undefined