File: type_error.md

package info (click to toggle)
node-addon-api 8.3.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,248 kB
  • sloc: cpp: 15,431; javascript: 5,631; ansic: 157; makefile: 7
file content (59 lines) | stat: -rw-r--r-- 1,671 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# TypeError

The `Napi::TypeError` class is a representation of the JavaScript `TypeError` that is
thrown when an operand or argument passed to a function is incompatible with the
type expected by the operator or function.

The `Napi::TypeError` class inherits its behaviors from the `Napi::Error` class (for more info
see: [`Napi::Error`](error.md)).

For more details about error handling refer to the section titled [Error handling](error_handling.md).

## Methods

### New

Creates a new instance of the `Napi::TypeError` object.

```cpp
Napi::TypeError::New(Napi::Env env, const char* message);
```

- `[in] Env`: The environment in which to construct the `Napi::TypeError` object.
- `[in] message`: Null-terminated string to be used as the message for the `Napi::TypeError`.

Returns an instance of a `Napi::TypeError` object.

### New

Creates a new instance of a `Napi::TypeError` object.

```cpp
Napi::TypeError::New(Napi::Env env, const std::string& message);
```

- `[in] Env`: The environment in which to construct the `Napi::TypeError` object.
- `[in] message`: Reference string to be used as the message for the `Napi::TypeError`.

Returns an instance of a `Napi::TypeError` object.

### Constructor

Creates a new empty instance of a `Napi::TypeError`.

```cpp
Napi::TypeError::TypeError();
```

### Constructor

Initializes a `Napi::TypeError` instance from an existing JavaScript error object.

```cpp
Napi::TypeError::TypeError(napi_env env, napi_value value);
```

- `[in] Env`: The environment in which to construct the `Napi::TypeError` object.
- `[in] value`: The `Napi::Error` reference to wrap.

Returns an instance of a `Napi::TypeError` object.