Compartir a través de

Validate class

  • Referencia
Paquete:
@microsoft/sp-core-library

Realiza pruebas de validación comunes para propiedades y parámetros de función.

Comentarios

Esta clase proporciona una forma estándar de validar propiedades y parámetros de función. A diferencia de las aserciones de depuración, las comprobaciones de validación siempre se llevan a cabo y siempre producirán un error, incluso en una versión de producción. Por tanto, procure no abusar de estas comprobaciones, ya que podría afectar al rendimiento.

Métodos

isNonemptyString(value, variableName)

Se produce una excepción si la cadena especificada es null, undefined o una cadena vacía.
isNotDisposed(value, className)

Produce una excepción si se ha eliminado el objeto especificado.
isNotNullOrUndefined(value, variableName)

Produce una excepción si el valor especificado es null o undefined.
isTrue(value, variableName)

Produce una excepción si el valor especificado no es True.

Detalles del método

isNonemptyString(value, variableName)

Se produce una excepción si la cadena especificada es null, undefined o una cadena vacía.

static isNonemptyString(value: string | undefined | null, variableName: string): void;

Parámetros

value

string | undefined | null

Valor que se va a comprobar.

variableName

string

Nombre de la variable del programa, que se mencionará en el mensaje de error.

Devoluciones

void

isNotDisposed(value, className)

Produce una excepción si se ha eliminado el objeto especificado.

static isNotDisposed(value: IDisposable, className: string): void;

Parámetros

value
IDisposable

Valor que se va a comprobar.

className

string

el nombre de la clase, que se mencionará en el mensaje de error

Devoluciones

void

isNotNullOrUndefined(value, variableName)

Produce una excepción si el valor especificado es null o undefined.

static isNotNullOrUndefined(value: unknown, variableName: string): void;

Parámetros

value

unknown

Valor que se va a comprobar.

variableName

string

Nombre de la variable del programa, que se mencionará en el mensaje de error.

Devoluciones

void

isTrue(value, variableName)

Produce una excepción si el valor especificado no es True.

static isTrue(value: boolean | undefined | null, variableName: string): void;

Parámetros

value

boolean | undefined | null

Valor que se va a comprobar.

variableName

string

Nombre de la variable del programa, que se mencionará en el mensaje de error.

Devoluciones

void