ts-validate-type

KO | EN

gitlite — search

#react #android #machine-learning #deep-learning #linux #docker #nodejs #macos #windows #cli #security #pytorch #ios #open-source

ts-validate-type

(★ 30)

Validate data at runtime using TypeScript types.

ts-validate-type 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ts-validate-type

## What?

Validate data at runtime **using TypeScript types**.

```ts
const user = validateType<{ name: string }>(data);
```

## Why?

Building apps in TypeScript often requires handling data we don't know the type
of at compile time. For example fetching data:

```ts
const myData = fetch("https://jsonplaceholder.typicode.com/todos/1")
  .then(response => response.json())
  .then(response => {
    // casting is unsafe!
    return response as {
      userId: number;
      id: number;
      title: string;
      completed: boolean;
    };
  });
```

With ts-validate-type:

```ts
const myData = fetch("https://jsonplaceholder.typicode.com/todos/1")
  .then(response => response.json())
  .then(response => {
    // throws error if response and type don't match
    return validateType<{
      userId: number;
      id: number;
      title: string;
      completed: boolean;
    }>(response);
  });
```

## How?

ts-validate-type requires a compile-time plugin to work. Given this example:

```ts
validateType<string>(data);
```

The plugin will add the `<string>` type parameter as a runtime argument (a
stringified object of type [`TsValidateType`](./common/ts-validate-type.ts)),
which is then used for validation:

```ts
validateType<string>(data, "{ ... }");
```

## Setup

> Note: currently only a TypeScript setup using Babel is supported.

1. Install dependencies
  ```bash
  npm install ts-validate-type
  ```
  ```bash
  npm install --save-dev babel-plugin-ts-validate-type
  ```
2. Add Babel plugin
  ```json
  "plugins": ["babel-plugin-ts-validate-type", ...]
  ```

## API

### `validateType`

```ts
function validateType<T>(value: unknown): T;
```

Checks the type of the `value` passed in matches the type argument `T`. Throws
error if the types don't match, otherwise returns the `value` passed in.

`T` must be an inline type. Using type variables like `<MyData>` is not
supported.

#### Examples

```ts
import { validateType } from "ts-validate-type";

try {
  const myValue = validateType<string>(value);
} catch (e) {
  // handle incorrect type
}
```

```ts
validateType<{
  version: "1";
  name: string;
  id: string | number;
  tags: string[];
  nested: { value: boolean };
  tuple: [bigint, bigint];
  data: any;
}>(data);
```

ts-validate-type

ts-validate-type 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

ts-validate-type

ts-validate-type 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README