dash.assert.type

Throw error if input is not an allowed data type

---

Syntax

dash.assert.type(input, types)
dash.assert.type(input, types, name, descriptor)
dash.assert.type(input, types, name, descriptor, idHeader)

---

Description

dash.assert.type(input, types)

Checks if input is the required data type. If not, throws an error.

dash.assert.type(input, types, name, descriptor)

Uses a custom name and data type descriptor in thrown error messages.

dash.assert.type(input, types, name, descriptor, idHeader)

Uses a custom header in thrown error IDs.

---

Input Arguments

input

input

any data type

The input being tested

types

types

string vector

The allowed data types

name

name

string scalar

The name of the input in the calling function for use in error messages. Default is “input”

descriptor

descriptor

string scalar

Descriptor for data type in error messages. Default is “data type”

idHeader

idHeader

string scalar

Header for thrown error IDs. Default is “DASH:assert:type”