Shadowly

TypeScript로 만든 체이닝 JSON 데이터베이스 모듈

시작하기

• 패키지 설치

npm i shadowly

사용법

새 JSON 만들기

generateNewJson 함수로 JSON을 새로 만들 수 있습니다.
|파라메터|타입|설명| |------|--------|-------| |path|string|만들 파일 경로| |isArray|boolean?|true면 배열 형식으로 생성|

import Shadowly from 'shadowly';

// example.json을 Object 형식으로 새로 만듭니다. (파일 내용: {})
Shadowly.generateNewJson("./object.json");

// array.json을 Array 형식으로 새로 만듭니다. (파일 내용: [])
Shadowly.generateNewJson("./array.json", true);

Shadowly 인스턴스 만들기

new Shadowly()로 Shadowly의 인스턴스를 새로 만들 수 있습니다. |파라메터|타입|설명| |------|--------|-------| |path|string|JSON 파일 경로|

import Shadowly from 'shadowly';

// object.json을 읽어들여 Shadowly의 인스턴스를 새로 만듭니다.
new Shadowly("./object.json");

// JSON의 타입 정의를 할 수 있습니다.
new Shadowly<typeof import("./array.json")>("./array.json");

JSON의 값 가져오기

get 함수는 특정 키로 이동합니다. |파라메터|타입|설명| |------|--------|-------| |key|string or number|키 이름입니다.|

import Shadowly from 'shadowly';

// key -> key2로 이동합니다.
new Shadowly("./object.json")
    .get("key")
    .get("key2");

value 함수는 이동한 키의 값을 가져옵니다.

import Shadowly from 'shadowly';

// key의 값을 가져옵니다.
new Shadowly("./object.json")
    .get("key")
    .value();

JSON에 값 쓰기

set 함수는 특정 키에 씁니다. |파라메터|타입|설명| |------|--------|-------| |value|any|쓸 값입니다.|

import Shadowly from 'shadowly';

// key 안에 있는 key2에 value2를 씁니다.
new Shadowly("./object.json")
    .get("key")
    .get("key2")
    .set("value2");

/*
결과:
{
    "key": {
        "key2": "value2"
    }
}
*/

remove 함수는 특정 키를 지웁니다. |파라메터|타입|설명| |------|--------|-------| |key|string or number|키 이름입니다.|

import Shadowly from 'shadowly';

// key 안에 있는 key2를 지웁니다.
new Shadowly("./object.json")
    .get("key")
    .remove("key2");

/*
결과:
{
    "key": {}
}
*/

그 외

back 함수는 한 번 뒤로 갑니다.

import Shadowly from 'shadowly';

// key 안에 있는 값을 가져옵니다.
// key에서 key2로 이동 후 뒤로가기 한 다음 값 가져오기
new Shadowly("./object.json")
    .get("key")
    .get("key2")
    .back()
    .value();

up 함수는 여러 번 뒤로 갑니다. |파라메터|타입|설명| |------|--------|-------| |steps|number?|뒤로 갈 횟수입니다.|

import Shadowly from 'shadowly';

// JSON 데이터를 가져옵니다.
// key에서 key2로 이동 후 뒤로 2번 이동 한 다음 값 가져오기
new Shadowly("./object.json")
    .get("key")
    .get("key2")
    .up(2)
    .value();

root 함수는 루트로 이동합니다.

import Shadowly from 'shadowly';

// JSON 데이터를 가져옵니다.
// key에서 key2로 이동 후 루트로 이동 한 다음 값 가져오기
new Shadowly("./object.json")
    .get("key")
    .get("key2")
    .root()
    .value();