[JS] Library | 01. Superstruct

https://docs.superstructjs.org/

Introduction | Superstruct

 

Superstruct는 특정 데이터가 의도된 형식으로 작성되어 있는지 확인하는 유효성 검사를 도와주는 패키지입니다.

 

각 변수와 함수들의 타입을 확인한다는 점에서 TypeScript와 동일한 역할을 수행하지만, 차이점이 있습니다.

TypeScript는 컴파일 단계에 존재하는 데이터에 대한 유효성만 검사하기 때문에,

컴파일 이후 런타임에서는 새로운 데이터에 대해 유효성을 검사할 수 없습니다(컴파일 이후에는 JS코드로 바뀌니까요).

반면 Superstruct는 런타임에서 유효성 검사를 실행할 수 있습니다.

 

Superstruct는 다음과 같이 사용합니다.

대조군이 될 superstruct 객체는 object( ) 함수로 생성하며,

대조군을 통한 비교는 assert( ) 함수를 이용합니다.

import * as s from 'superstruct';

// superstruct 객체 선언
const Checker = s.object({
  variable1: [variable1의 검사 내용]
  variable2: [variable2의 검사 내용]
  ...
});

...

// superstruct 객체 호출
s.assert([비교할 객체], Checker)

검사 내용은 타입, 길이, 특정 형식 등 여러 가지가 올 수 있습니다.

 

타입 지정은 superstruct.[타입이름]( ) 으로 작성 가능합니다.

const Checker = s.object({
    age:      s.int(),     // 숫자
    address:  s.string(),  // 문자열
    isMember: s.boolean(), // 조건
});

값의 길이를 조건으로 할 수 있습니다. 이 경우 size( ) 함수를 사용합니다.

const Checker = s.object({
    name:  s.size(s.string(), 1, 8),  // 1~8자 사이의 문자열
});

좀 더 복잡한 형식이 필요하면 외부 라이브러리 함수를 사용해도 됩니다.

import isEmail from 'is-email';  // 이메일의 포맷을 검사하는 라이브러리입니다.

export const CreateUser = s.object({
  email: s.define('Email', isEmail),  // Email 타입은 isEmail()의 함수값
});

 

만약 특정 객체의 전체 데이터가 아닌 일부 변경사항에 대해서만(e.g. 이름을 수정) 유효성 검사를 한다면,

partial( ) 함수를 사용하면 됩니다.

const PatchChecker = s.partial(Checker);

...

s.assert([비교할 객체], PatchChecker);