이 페이지의 내용
문서API 레퍼런스
API 레퍼런스05

BindCommand

명령의 실행, 출력 옵션, 콜백과 뷰를 살펴봅니다.

한국어 문서약 48분

각 명령에 대한 객체 역활을 수행하며 MetaView와 콜백(hooking)함수로 구성되어 있으며 execute() 메서드 호출을 통해 실행됩니다.

구성 요소#

속성#

항목 설명
_baseTable BindCommand 객체의 기본 테이블입니다.
_outputs 명령 실행 후 결과 데이터를 담고 있는 MetaView 컬렉션입니다.
_model 명령(BindCommand) 객체가 속한 BindModel 객체를 가르킵니다.
config 서버 요청에 필요한 정보를 설정합니다 (axios 설정)
url 요청 경로를 정의합니다.
outputOption 서버 응답 데이터를 처리하는 방식을 정의합니다. (기본값 = 0)<br>- 'SEND' : 안가져옴<br>- 'ALL' : 모든 column 및 rows 가져오기<br>- 'PICK' : 존재하는 column 의 rows 가져오기 <br>- 'VIEW' : 존재하는 column 의 rows 가져오기 + row값 value 설정
valid 데이터 유효성을 검사하는 데 사용되는 MetaView 입니다.
bind 서버 요청 데이터를 정의하는 MetaView 입니다.
output 서버 응답 데이터를 저장하는 MetaView 입니다.
misc 기타 MetaView 입니다. (컬럼 그룹화에 활용)
cbBegin 명령 실행 시 가장 먼저 호출되는 콜백 함수입니다.
cbValid 유효성 검사 전에 호출되는 콜백 함수입니다.
cbBind 명령 실행 시 데이터를 서버로 전송하기 전에 호출되는 콜백 함수입니다.
cbResult 전송받은 서버 응답 데이터를 처리하는 콜백 함수입니다.
cbOutput 명령 실행 후 서버 응답 데이터를 화면에 출력하는 콜백 함수입니다.
cbEnd 명령 실행이 완료된 후 호출되는 콜백 함수입니다.

메소드#

항목 설명
execute() 유효성 검사, 데이터 전송, 응답 처리를 수행합니다.
addColumn() 테이블에 컬럼을 추가하고 뷰에 참조값을 등록합니다.
addColumnValue() 테이블에 초기값과 함께 컬럼을 추가하고, 뷰에 참조값을 등록합니다.
setColumn() 기존에 정의된 컬럼을 지정된 뷰에 설정합니다.
release() 지정된 뷰에서 컬럼 설정을 해제합니다.
newOutput() 새로운 출력 뷰를 생성합니다.
removeOutput() 특정 출력 뷰를 삭제합니다.

이벤트#

항목 설명
onExecute 명령(BindCommand)이 실행되기 전에 호출되는 이벤트입니다.
onExecuted 명령(BindCommand)이 실행된 후 호출되는 이벤트입니다.

주요 속성#

_baseTable#

BindCommand 객체의 기본 테이블 속성입니다.

ts
type _baseTable = MetaTable;
  • MetaTable: BindCommand의 기본 테이블

_baseTable 속성은 데이터를 관리하는 기본 테이블로, 명령과 컬럼 매핑의 중심 역할을 수행합니다. 컬럼 추가 및 설정 시 기본적으로 참조되는 테이블을 나타냅니다.

  • 명령(BindCommand)이 속한 BindModel 객체의 테이블을 가르킵니다.
  • 명령(BindCommand) 생성시 지정하거나, _baseTable 속성을 직접 변경할 수 있습니다.

Tip : 관련 메소드

  • addColumn(): 컬럼 추가할 때 기본 테이블로 사용됩니다.
  • addColumnValue(): 초기값을 포함된 컬럼을 추가할 때 기본 테이블로 사용됩니다.
  • setColumn(): 컬럼 매핑 작업에서 기본 테이블로 사용됩니다.
js
const bm = new BindModel();

console.log(bm._baseTable === bm.first);            // true
console.log(bm._baseTable === bm._tables['first']); // true
console.log(bm._baseTable === bm._tables[0]);       // true

_outputs#

명령 실행 후 결과 데이터를 담고 있는 MetaView 컬렉션 속성입니다.

ts
type _outputs = MetaViewCollection;
  • MetaViewCollection: MetaView 객체 컬렉션

Tip: 복수 출력 뷰(MetaView)를 처리할 때  _outputs를 사용하여 분리하여 관리할 수 있습니다.

_outputs속성은 명령 실행 결과 데이터를 저장하는 컬렉션입니다.

  • _outputs[0]은 항상 output 속성과 동일합니다.
  • newOutput() 메서드를 사용하여 추가적인 출력 뷰를 생성할 수 있습니다.

참조 : addOutput() 메소드

js
const bm = new BindModel();

// 명령 추가
bm.addCommand('list');

// 출력 뷰 추가
bm.command['list'].newOutput();

// 명령 실행
bm.command['list'].execute();

console.log(bm.command['list']._outputs[0]); // [Object MetaView] *기본*
console.log(bm.command['list']._outputs[1]); // [Object MetaView] *추가*
  • _outputs[0]: 명령 실행 후 서버 응답 데이터를 가져오는 첫번째 MetaView입니다.
  • _outputs[1]: newOutput()으로 추가된 MetaView입니다.

_model#

명령(BindCommand) 객체가 속한 BindModel 객체를 가르키는 속성입니다.

ts
type _model = BindModel;
  • BindModel: 명령이 속한 모델 객체

_model 속성은 명령 객체(BindCommand)가 속한 BindModel 객체를 참조합니다.

Tip: _model을 통해 BindModel 객체의 columns, command, _tables 속성에 접근할 수 있습니다.

js
const bm = new BindModel();

bm.addColumnValue('u_id', 'abc');
bm.addCommand('list');

bm.command['list'].cbBegin = function(model, cmd) {
    console.log(model.columns['u_id'].value); // Out: 'abc'
};
  • model: 현재 명령이 속한 BindModel 객체를 참조합니다.

config#

서버 요청에 필요한 정보를 설정하는 속성입니다.

ts
type config = {
    method?: 'GET' | 'POST' | 'PUT' | 'DELETE',
    url?: string,
    baseUrl?: string,
	responseType?: 'json' | 'text' | 'blob'
};
  • method(선택): HTTP 요청 방식 (기본값 'GET')
  • url(선택): 요청 경로
  • baseUrl(선택): url 과 결합되는 기본 경로 (도메인)
  • responseType(선택): 서버 응답 데이터 형식 (기본값 'json')

추가 속성에 대한 자세한 내용은 Axios의 config 문서를 참조하세요.

config 속성은 서버 요청의 설정을 관리하는 속성입니다.

  • config 속성이 설정되지 않으면 BindModel 객체의 baseConfig 속성이 기본값으로 사용됩니다.
  • config 속성은 axios 설정(config)의 역활을 수행하며 URL, HTTP 메서드, 응답 데이터 형식 등 주요 설정 값을 지정합니다.

Tip: config 속성을 활용하여 인증 토큰 추가, 요청 데이터 포맷 지정, 서버와의 세부 통신 방식을 효율적으로 관리할 수 있습니다.

js
const bm = new BindModel();

bm.addCommand('cmd1');

// 명령의 서버 요청 설정
bm.command['cmd1'].config = {
    method: 'GET',
    url: '/api/users',
    headers: { Authorization: 'Bearer token123' },
    timeout: 5000
};

// 명령 실행
bm.command['cmd1'].execute();
  • method: HTTP 메서드로 'GET'을 설정했습니다.
  • url: 서버 요청 URL을 /api/users로 설정했습니다.
  • headers: 인증 토큰을 포함한 헤더를 설정했습니다.
  • timeout: 요청 제한 시간을 5000ms로 설정했습니다.

url#

요청 경로를 정의하는 속성입니다.

ts
type url = string;
  • string: 서버 요청 경로

url 속성은 서버 요청 경로의 역할을 합니다.

  • url은 config.url속성의 참조값입니다.
  • url 값을 설정하지 않으면 BindModel 객체의 url 속성이 기본값으로 사용됩니다.
  • config.baseUrl 속성과 조합하여 전체 URL을 구성할 수 있습니다.
js
const bm = new BindModel();

// 명령 추가
bm.addCommand('cmd1');

// URL 설정
bm.command['cmd1'].url = '/api/data';

bm.command['cmd1'].execute();
  • execute() 실행시 /api/data 경로로 서버에 요청을 보냅니다.

동적 url 설정 예제

js
const bm = new BindModel();

// 명령 및 컬럼 추가
bm.addCommand('cmd1');
bm.addColumnValue('u_id', 10);

// 동적 URL 설정
bm.command['cmd1'].cbBegin = function(model, cmd) {
    const userId = model.columns['u_id'].value;
    cmd.url = `/api/users/${userId}`;
};

bm.command['cmd1'].execute();
  • execute() 실행 시 동적으로 설정된 요청 경로로 서버에 요청을 보냅니다.

outputOption 또는 outOpt#

서버 응답 데이터를 처리하는 방식을 정의하는 속성입니다.

별칭으로 outOpt 참조 속성을 제공합니다.

ts
type outputOption = {
    option: 0 | 1 | 2 | 3,
    index?: number
} | number;
  • option: 출력 데이터 처리 방식
    • 0: 데이터를 바인딩하지 않습니다.
    • 1: 모든 데이터를 가져옵니다.
    • 2: 정의된 컬럼과 매칭되는 데이터(row)만 가져옵니다.
    • 3: 특정 인덱스 데이터를 컬럼 값으로 설정합니다.
  • index(선택): option: 3일 때, 값을 가져올 데이터의 인덱스 (기본값 0)
  • number: outputOption.option 값을 설정 (0 ~ 3)

outputOption 속성은 서버에서 반환된 데이터를 처리하는 방식을 설정하며, 데이터 바인딩 및 컬럼 값 설정을 제어할 수 있습니다.

  • 인자값이 option = 0 이면, 데이터 바인딩이 비활성화됩니다. (기본값)
  • 인자값이 option = 3 이면, index 에 지정한 데이터가 컬럼 value 값으로 설정됩니다.

outputOption 직접 설정 예제

js
const bm = new BindModel();

// 명령 추가 
bm.addCommand('cmd1');
bm.addCommand('cmd2');
bm.addCommand('cmd3');
bm.addCommand('cmd4');

// 및 outputOption 설정
bm.command['cmd2'].outputOption = 1;
bm.command['cmd3'].outOpt = { option: 2 }
bm.command['cmd4'].outputOption = { option: 3, index: 2 };
// 명령 실행
bm.command['cmd1'].execute();   // option = 0, index = 0
bm.command['cmd2'].execute();   // option = 1, index = 0
bm.command['cmd3'].execute();   // option = 2, index = 0
bm.command['cmd4'].execute();   // option = 3, index = 2

명령 추가시 outputOption 설정 예제

js
const bm = new BindModel();

// 명령 추가 및 outputOption 설정
bm.addCommand('cmd1');
bm.addCommand('cmd2', 1);
bm.addCommand('cmd3', { option: 2});
bm.addCommand('cmd4', { option: 3, index: 2 });

// 명령 실행
bm.command['cmd1'].execute();   // option = 0, index = 0
bm.command['cmd2'].execute();   // option = 1, index = 0
bm.command['cmd3'].execute();   // option = 2, index = 0
bm.command['cmd4'].execute();   // option = 3, index = 2
  • cmd1 명령: 기본값으로 설정되어 데이터 바인딩을 비활성화합니다 (option: 0)
  • cmd2 명령: 서버 응답의 모든 데이터를 가져옵니다 (option: 1)
  • cmd3 명령: 정의된 컬럼과 매칭되는 데이터만 가져옵니다 (option: 2)
  • cmd4 명령: 특정 인덱스(2)의 데이터(row)를 컬럼 값으로 설정합니다 (option: 3, index: 2)

valid#

데이터 유효성을 검사하는 데 사용되는 MetaView 속성입니다.

ts
type valid = MetaView;
  • MetaView: 데이터 유효성 뷰

참조

  • HTMLColumn 클래스 requred 속성
  • HTMLColumn 클래스 constraints 속성
  • HTMLColumn 클래스 valid() 메소드

valid(MetaView) 속성에 정의된 컬럼들의 제약조건(constraints)과 필수(required) 여부를 확인하여 데이터(value)의 유효성을 검사합니다.

  • 서버 전송 전에 컬럼의 제약 조건(constraints)과 필수 조건(required)을 검사합니다.
  • 유효성 검사에 실패한 경우, cbFail 콜백함수가 호출됩니다.

Tip: 유효성 검사는 명령 실행시 첫단계에서 수행되며, 데이터 무결성을 보장합니다.

js
const bm = new BindModel();

bm.addCommand('cmd1');

// 컬럼 추가
bm.command['cmd1'].valid.columns.add('u_id');
bm.command['cmd1'].valid.columns.add('phone');
// 위와 동일
// bm.command['cmd1'].addColumn('u_id', 'valid');
// bm.command['cmd1'].addColumn('phone', 'valid');

// 제약 조건 설정
bm.columns['u_id'].required = true;
bm.columns['phone'].constraints = {
    regex: /^\d{10,11}$/,
    msg: '전화번호는 10~11자리 숫자여야 합니다.'
};

bm.command['cmd1'].execute();
  • 명령 실행시 valid 속성에 정의된 컬럼의 유효성을 검사합니다.
  • 컬럼의 required 속성과 constraints 속성을 기반으로 검증을 수행합니다.

bind#

서버 요청 데이터를 정의하는 MetaView 속성입니다.

ts
type bind = MetaView;
  • MetaView: 서버 요청 뷰

bind 속성은 명령 실행 시 서버로 데이터를 전송하는 데 사용됩니다. MetaView 에 설정된 컬럼과 value 값으로 요청 데이터를 구성하여 전송합니다.

Tip: bind는 서버와의 통신에서 데이터 전송의 핵심 역할을 하며, RESTful API 요청에 유용합니다.

js
const bm = new BindModel();

bm.addCommand('cmd1');

// 컬럼 추가
bm.command['cmd1'].bind.columns.add('u_id');
bm.command['cmd1'].bind.columns.add('email');
bm.command['cmd1'].bind.columns['u_id'].value = 101;
bm.command['cmd1'].bind.columns['email'].value = 'abc@gmail.com';
// 위와 동일
// bm.command['cmd1'].addColumnValue('u_id', 101, 'bind');
// bm.command['cmd1'].addColumnValue('email', 'abc@gmail.com', 'bind');

bm.command['cmd1'].execute();
  • bind 속성은 서버 요청 데이터를 관리하며, 명령 실행 시 전송 데이터를 구성합니다.

output#

서버 응답 데이터를 저장하는 MetaView 속성입니다.

ts
type output = MetaView;
  • MetaView: 서버 응답 데이터 뷰

output 속성은 서버 응답 데이터를 저장하는 MetaView 이며, 화면 표시나 데이터 처리를 위해 사용됩니다.

  • outputOption 속성이 0이면 경우에는 output 속성에 데이터를 가져오지 않습니다.
  • cbOutput 콜백함수에서 output 데이터를 화면에 표시하는 후속 작업을 처리합니다.

Tip: 복수의 출력을 처리하기 위해서는 newOuput() 메소드를 활용하여 처리합니다.

참조 : cbOutput 속성, newOutput() 메소드

js
const bm = new BindModel();

// 명령 추가 : 첫번째 데이터(row)를 컬럼값에 설정
bm.addCommand('cmd1', 3);

// 응답 데이터를 처리할 컬럼 추가
bm.command['cmd1'].output.columns.add('u_id');
bm.command['cmd1'].output.columns.add('u_name');
// 위와 동일
// bm.command['cmd1'].addColumn('u_id', 'output');
// bm.command['cmd1'].addColumn('u_name', 'output');

// 명령 실행
bm.command['cmd1'].execute();

console.log(bm.columns['u_id']);  // [Object HTMLColumn]
console.log(bm.command['u_name']); // [Object HTMLColumn]
  • cmd1 명령은 outputOption = 3으로 설정하여 첫 번째 데이터를 컬럼값으로 저장합니다.

cbBegin#

명령 실행 시 가장 먼저 호출되는 콜백 함수입니다.

ts
type cbBegin = (model: BindModel, cmd: BindCommand) => void;
  • model : 현재 모델(BindModel) 객체 입니다.
  • cmd: 실행 중인 명령(BindCommand) 객체

cbBegin 속성은 명령 실행 흐름에서 첫 번째로 호출되는 콜백 함수입니다.

  • 명령 실행 전에 필요한 설정을 동적으로 설정할 수 있습니다. (동적 경로 지정)
  • 명령별로 cbBegin 콜백 함수가 없으면 cbBaseBegin 콜백 함수가 호출됩니다.
js
const bm = new BindModel();

// 명령 추가 및 컬럼 값 설정
bm.addCommand('cmd1');
bm.addColumnValue('u_id', 100);

// 콜백 함수 설정
bm.command['cmd1'].cbBegin = function(model, cmd) {
    const userId = model.columns['u_id'].value;
    cmd.url = `/api/users/${userId}`;
};

// 명령 실행
bm.command['cmd1'].execute();
  • cbBegin 콜백함수에서 서버 전송 전에 u_id 컬럼값을 기반으로 URL을 동적으로 설정합니다.

cbValid#

유효성 검사 전에 호출되는 콜백 함수입니다.

ts
type cbValid = (valid: MetaView, cmd: BindCommand, model: BindModel) => boolean | undefined;
  • view: 유효성 검사를 수행할 대상인 MetaView 객체
  • cmd: 실행 중인 명령(BindCommand) 객체
  • model : 현재 모델(BindModel) 객체 입니다.
  • 반환값:
    • true: 유효성 검사를 통과하고 다음 단계로 진행합니다.
    • false: 유효성 검사가 실패하며, cbFail 콜백이 호출됩니다.
    • undefined: 유효성 검사가 실패하지만, cbFail은 호출되지 않습니다.

cbValid 속성은 명령 실행 중 데이터의 유효성을 검사하기 전에 호출되는 콜백함수입니다.

  • 기본 유효성 검사 로직 외에 추가적인 검증 로직을 적용할 수 있습니다.
  • 명령별로 cbValid 콜백 함수가 없으면 cbBaseValid 콜백 함수가 호출됩니다.
  • 유효성 실패를 개별로 처리할 경우 cbValid 함수에 처리하고 undefined를 반환합니다.
js
const bm = new BindModel();

// 명령 추가 
bm.addCommand('cmd1');

// 컬럼 추가 및 뷰 매핑
bm.addColumnValue('u_name', 'John', 'cmd1', 'valid');

// 콜백 함수 설정
bm.command['cmd1'].cbValid = function(view, cmd, model) {
    const username = view.columns['u_name'].value;
    if (username.length < 5) {
        console.log('사용자 이름은 5자 이상이어야 합니다.');
        return false;
    }
    return true;
};

// 명령 실행
bm.command['cmd1'].execute();
  • cbValid 콜백함수에서 valid 유효성 검사 전에 u_name 컬럼값을 검사합니다.

cbBind#

명령 실행 시 데이터를 서버로 전송하기 전에 호출되는 콜백 함수입니다.

ts
type cbBind = (
    bind: MetaView, 
    cmd: BindCommand, 
    config: object
) => void;
  • bind: 서버로 전송할 데이터를 포함하는 MetaView 객체
  • cmd: 실행 중인 명령(BindCommand) 객체
  • config: axios 요청 설정 객체

cbBind 속성은 명령 실행 중 서버 요청 데이터를 준비하기 위해 호출되는 콜백함수입니다.

  • 서버로 데이터를 전송하기 전에 요청 설정을 동적으로 설정할 수 있습니다.
  • 명령별로 cbBind 콜백 함수가 없으면 cbBaseBind 콜백 함수가 호출됩니다.

Tip: 전송할 데이터의 암호화 또는 토큰 추가 등 데이터 포멧 변환에 활용할 수 있습니다.

js
const bm = new BindModel();

// 명령 추가
bm.addCommand('upload');

// 컬럼 추가 및 뷰 매핑
bm.addColumnValue('file_name', 'file.txt', 'upload', 'bind');
bm.addColumnValue('file_size', 2048, 'upload', 'bind');

// 콜백 함수 설정
bm.command['upload'].cbBind = function(bind, cmd, config) {
    config.headers = {
        'Content-Type': 'application/json'
    };
};

// 명령 실행
bm.command['upload'].execute();
  • cbBind콜백함수에서 서버 요청 데이터에 header 정보를 추가합니다.

cbResult#

전송받은 서버 응답 데이터를 처리하는 콜백 함수입니다.

ts
type cbResult = (
    data: object, 
    cmd: BindCommand, 
    response: object
) => object;
  • data: 서버에서 반환된 데이터
  • cmd: 실행 중인 명령(BindCommand) 객체
  • response: 원본 axios 응답 객체
  • 반환값: 변환된 데이터를 반환하며, 이후 단계에서 사용되거나 cbOutput에 전달됩니다.

cbResult 속성은 서버에서 반환된 데이터를 MetaView 스키마 형식으로 변환할 때 사용되는 콜백 함수입니다.

  • 내부적으로 반환된 데이터는 output 뷰의 read(data) 메서드로 전달됩니다.
  • 명령별로 cbResult 콜백 함수가 없으면 cbBaseResult 콜백 함수가 호출됩니다.

참조 : MetaView 의 스키마 데이터 읽기 메소드, read()

js
const bm = new BindModel();

// 명령 추가
bm.addCommand('cmd1', 1);

// 콜백 함수 설정
bm.command['cmd1'].cbResult = function(data, cmd, response) {
    return { rows: data.rows.filter(product => product.inStock) };
};

// 명령 실행
bm.command['cmd1'].execute();
  • cbResult 콜백 함수에서 서버 응답 데이터를 변환하는 작업을 수행합니다.

cbOutput#

명령 실행 후 서버 응답 데이터를 화면에 출력하는 콜백 함수입니다.

ts
type cbOutput = (
    outputs: MetaViewCollection, 
    cmd: BindCommand, 
    response: object
) => object;
  • outputs: 매핑된 데이터를 포함하는 MetaViewCollection 객체
    • outputs[0] 은 output 속성을 가르킵니다.
    • outputs[뷰 이름] 또는 outputs[인덱스]을 통해서 뷰에 접근합니다.
  • cmd: 현재 실행 중인 BindCommand 객체
  • response: axios 응답 객체

cbOutput 속성는 명령 실행 시 output 뷰에 데이터를 매핑한 뒤 호출되는 콜백함수입니다.

  • outputOption 속성이 1, 2, 3 일 경우에만 호출됩니다.
  • 응답 데이터를 기반으로 화면에 출력하거나 로그를 기록합니다.
  • 명령별로 cbOutput 콜백 함수가 없으면 cbBaseOutput 콜백 함수가 호출됩니다.

Tip: newOutput('뷰이름') 메소드로 뷰를 추가할 수 있습니다.

참조 : 명령 복수 출력 구성

js
const bm = new BindModel();

// 명령 추가 (1: 모든 데이터 가져오기)
bm.addCommand('cmd1', 1);

// 콜백 함수 설정
bm.command['cmd1'].cbOutput = function(outputs, cmd, response) {
    const output = outputs[0]; // 첫번째 기본 MetaView
    output.rows.forEach(product => {
        console.log(`Product ID: ${product.u_id}, Name: ${product.name}`);
    });
};

bm.command['cmd1'].execute();
// Product ID: ...., Name: ....
  • cbOutput 콜백함수에서 매핑된 데이터 outputs[0]뷰의 행(rows)을 출력합니다.

cbEnd#

명령 실행이 완료된 후 호출되는 콜백 함수입니다.

ts
type cbEnd = (
    status?: number, 
    cmd?: BindCommand, 
    response?: object
) => void;
  • status(선택): 명령 실행 결과를 나타내는 상태 코드
  • cmd(선택): 현재 실행된 BindCommand 객체
  • response(선택): 서버에서 반환된 응답 객체

cbEnd 속성은 명령 실행 후 최종 결과를 처리하는 콜백 함수입니다.

  • 명령별로 cbEnd 콜백 함수가 없으면 cbBaseEnd 콜백 함수가 호출됩니다.

Tip : 명령 실행 후 후속 작업을 수행하는데 활용할 수 있습니다.

js
const bm = new BindModel();

// 명령 추가
bm.addCommand('cmd1');

// 콜백 함수 설정
bm.command['cmd1'].cbEnd = function(status, cmd, response) {
    if (status > 0) console.log('데이터 저장이 완료되었습니다.');
    else console.log('데이터 저장 중 오류가 발생했습니다.');
};

bm.command['cmd1'].execute();
  • cbEnd 콜백함수는 명령 실행 후 마지막으로 호출되어, 최종 상태를 처리합니다.

주요 메소드#

exectue() 또는 exec()#

유효성 검사, 데이터 전송, 응답 처리를 수행하는 메서드입니다.

별칭으로 exec() 참조 메서드를 제공합니다.

ts
declare function execute(): Promise<void>;
  • 반환값: Promise<void>. 명령 실행이 비동기 작업으로 처리되며, 완료 시 아무 값도 반환하지 않습니다.
  • Promise 기반: 명령 실행 흐름을 비동기로 관리할 수 있어, 실행 완료 후 추가 작업을 체인으로 연결할 수 있습니다.

execute() 메소드는 BindCommand 객체를 실행하는 메서드로, 다음과 같은 흐름으로 동작합니다:

  • valid MetaView 속성을 기반으로 데이터의 유효성을 확인합니다.
  • bind MetaView 속성을 사용하여 서버로 데이터를 전송합니다.
  • 서버에서 반환된 데이터를 output MetaView에 매핑합니다.
  • 단계별 콜백 함수를 호출합니다. (cbBegin, cbValid, cbBind, cbResult, cbOutput, cbEnd)

Tip : execute() 메서드는 try 문으로 구성되어 있으며, catch 블럭에서 cbError 콜백 함수가 호출됩니다.

참조 : 5. 흐름 제어, 4. 실행 및 동기화

js
const bm = new BindModel();

// 명령 추가
bm.addCommand('cmd1');

// 유효성 검사 및 서버 요청 추가
bm.command['cmd1'].addColumn('u_name', ['valid', 'bind']);

// 값 및 제약 조건 설정
bm.columns['u_name'].require = true;
bm.columns['u_name'].value = 'John';

// 명령 실행
bm.command['cmd1'].execute();
  • u_name 컬럼은 유효성 검사(valid)와 서버 전송(bind) 대상으로 설정합니다.
  • 명령을 실행하여 유효성 검사, 데이터 전송, 응답 처리를 순차적으로 수행합니다.

addColumn()#

테이블에 컬럼을 추가하고 뷰에 참조값을 등록하는 메서드입니다.

ts
type ViewType = '$all' | 'valid' | 'bind' | 'output' | 'misc' | string;

declare function addColumn(
    column: string | MetaColumn,
    views?:  ViewType | ViewType[],
    table?: MetaTable | string
): void;

  • column: 추가할 컬럼의 이름(문자열) 또는 MetaColumn 객체
  • views(선택): 컬럼을 매핑할 뷰를 이름 또는 이름 배열
    • '$all': 모든 뷰 (기본값)
    • 'valid': 유효성 검사를 위한 뷰
    • 'bind': 서버 요청 데이터를 위한 뷰
    • 'output': 응답 데이터를 매핑하는 뷰
    • 'misc': 추가적인 뷰
    • string: 사용자 정의 출력 뷰
  • bTable(선택): 컬럼을 추가할 MetaTable 객체 (기본값은 _baseTable)

addColumn() 메서드는 모델에 컬럼을 추가하고, 지정한 뷰에 참조값을 등록합니다.

  • views 인자는 기본적으로 전체 뷰가 지정되어 있습니다. (기본값 $all)

모든 뷰에 컬럼 추가 예제

js
const bm = new BindModel();

// 명령 및 컬럼 추가
bm.addCommand('cmd1');
bm.command['cmd1'].addColumn('u_name');
// 위와 동일
// bm.command['cmd1'].addColumn('u_name', '$all'); 

console.log(bm.command['cmd1'].valid.columns['u_name']); // [Object HTMLColumn]
console.log(bm.command['cmd1'].bind.columns['u_name']);  // [Object HTMLColumn]
console.log(bm.command['cmd1'].output.columns['u_name']);// [Object HTMLColumn]
console.log(bm.command['cmd1'].misc.columns['u_name']);  // [Object HTMLColumn]
  •  u_name 컬럼은 모든 뷰(valid, bind, output, misc)에 참조값이 등록됩니다.

특정 뷰에만 컬럼 등록 예제

js
// 컬럼 추가 및 뷰에 참조 등록
bm.command['cmd1'].addColumn('email', 'valid');
bm.command['cmd1'].addColumn('phone', ['bind','output']);

console.log(bm.command['cmd1'].valid.columns['email']); // [Object HTMLColumn]
console.log(bm.command['cmd1'].bind.columns['phone']);  // [Object HTMLColumn]
console.log(bm.command['cmd1'].output.columns['phone']);// [Object HTMLColumn]
  • email 컬럼을 valid 뷰에만 매핑하고,
  • phone 컬럼은 bind와 output 뷰에 매핑합니다.

사용자 정의 출력 뷰에 추가 예제

js
// 출력 뷰 추가
bm.command['cmd1'].newOutput('out2');

// 컬럼 추가 및 추가 출력 뷰에 참조 등록
bm.command['cmd1'].addColumn('address', 'out2');

console.log(bm.command['cmd1'].out2.columns['address']); // [Object HTMLColumn]
  • 추가된 출력 뷰(out2)에 address 컬럼이 매핑됩니다.

addColumnValue()#

테이블에 초기값과 함께 컬럼을 추가하고, 뷰에 참조값을 등록하는 메서드입니다.

ts
type ViewType = '$all' | 'valid' | 'bind' | 'output' | 'misc' | string;

declare function addColumnValue(
    columnName: string, 
    value: any, 
    views?: ViewType | ViewType[],
    table?: MetaTable | string
): void;
  • columnName: 추가할 컬럼의 이름
  • value: 초기값으로 설정할 데이터
  • views(선택): 컬럼을 매핑할 뷰를 이름 또는 이름 배열
    • '$all': 모든 뷰 (기본값)
    • 'valid': 유효성 검사를 위한 뷰
    • 'bind': 서버 요청 데이터를 위한 뷰
    • 'output': 응답 데이터를 매핑하는 뷰
    • 'misc': 추가적인 뷰
    • string[]: 사용자 정의 출력 뷰
  • bTable(선택): 컬럼을 추가할 MetaTable 객체 (기본값은 _baseTable)

addColumn() 메서드는 컬럼을 추가하면서 초기값을 설정하고, 지정된 뷰에 참조값을 등록합니다.

  • 컬럼을 추가하면서 초기값을 함께 지정할 수 있습니다.
  • views 인자를 통해 컬럼이 어떤 뷰에서 매핑할지 지정할 수 있습니다.

모든 뷰에 컬럼 추가 예제

js
const bm = new BindModel();

// 명령 추가
bm.addCommand('cmd1');

// 컬럼 초기값으로 등록
bm.command['cmd1'].addColumnValue('u_name', 'John', ['$all']);

console.log(bm.command['cmd1'].valid.columns['u_name'].value);  // Out: 'John'
console.log(bm.command['cmd1'].bind.columns['u_name'].value);   // Out: 'John'
console.log(bm.command['cmd1'].output.columns['u_name'].value); // Out: 'John'
  •  username 컬럼은 모든 뷰(valid, bind, output, misc)에 참조값이 등록됩니다.

특정 뷰에만 컬럼 등록 예제

js
// 컬럼 추가 및 뷰에 매핑
bm.command['cmd1'].addColumnValue('email', 'abc@gmail.com', 'valid');
bm.command['cmd1'].addColumnValue('phone', '12345', ['bind','output']);

console.log(bm.cmd['cmd1'].valid.columns['email'].value); // Out: 'abc@gmail.com'
console.log(bm.cmd['cmd1'].bind.columns['phone'].value);  // Out: 12345
console.log(bm.cmd['cmd1'].output.columns['phone'].value);// Out: 12345
  • email 컬럼을 valid 뷰에만 매핑되고,
  • phone 컬럼은 bind와 output 뷰에 매핑됩니다.

사용자 정의 출력 뷰에 추가 예제

js
// 출력 뷰 추가
bm.command['cmd1'].newOutput('out2');

// 컬럼 추가 및 뷰에 매핑
bm.command['cmd1'].addColumnValue('address', 'Home', 'out2');

console.log(bm.command['cmd1'].out2.columns['address'].value); // Out: 'Home'
  • 추가된 출력 뷰(out2)에 address 컬럼이 매핑됩니다.

setColumn()#

기존에 정의된 컬럼을 지정된 뷰에 설정하는 메서드입니다.

ts
type ViewType = '$all' | 'valid' | 'bind' | 'output' | 'misc' | string;
declare function setColumn(
	columnNames: string | string[], 
	views: ViewType | ViewType[],
	table?: MetaTable | string
): void;
  • columnNames: 설정할 컬럼의 이름 또는 이름 배열
  • views: 컬럼을 매핑할 뷰를 이름 또는 이름 배열
    • '$all': 모든 뷰 (기본값)
    • 'valid': 유효성 검사를 위한 뷰
    • 'bind': 서버 요청 데이터를 위한 뷰
    • 'output': 응답 데이터를 매핑하는 뷰
    • 'misc': 추가적인 뷰
    • string[]: 사용자 정의 출력 뷰
  • bTable(선택): 컬럼을 추가할 MetaTable 객체 (기본값은 _baseTable)

setColumn() 메서드는 기존에 정의된 컬럼을 지정한 뷰에 설정하는 메서드입니다.

  • 특정 컬럼을 하나 이상의 뷰에 매핑합니다. (컬럼 참조값 등록)
  • 다수의 컬럼을 동시에 설정할 수 있어 반복 작업을 줄일 수 있습니다.

Tip: setColumn()을 사용하면 데이터 처리 로직을 유연하게 구성할 수 있습니다.

단일 컬럼 설정 예제

js
const bm = new BindModel();

// 명령 추가
bm.addCommand('cmd1');
bm.addCommand('cmd2');
bm.addCommand('cmd3');

// 컬럼 추가
bm.columns.addValue('aa', 10);
bm.columns.addValue('bb', 20);
bm.columns.addValue('cc', 30);

// 컬럼 참조 설정
bm.command['cmd1'].setColumn('aa', 'output');

console.log(bm.command['cmd1'].output.columns['aa'].value); // Out: 10
  • 컬럼 aa를 output 뷰에 설정하고 값을 확인합니다.
js
// 컬럼 참조 설정
bm.command['cmd2'].setColumn(['bb', 'cc'], ['valid', 'bind']);

console.log(bm.command['cmd2'].valid.columns['bb'].value);  // Out: 20
console.log(bm.command['cmd2'].bind.columns['cc'].value);   // Out: 30
console.log(bm.command['cmd2'].valid.columns['bb'].value);  // Out: 20
console.log(bm.command['cmd2'].bind.columns['cc'].value);   // Out: 30
  • 컬럼 bb와 cc를 각각 valid와 bind 뷰에 설정합니다.
js
// 컬럼 참조 설정
bm.command['cmd3'].setColumn('aa', '$all'); // views 기본값 : '$all'

console.log(bm.command['cmd3'].valid.columns['aa'].value);  // Out: 10
console.log(bm.command['cmd3'].bind.columns['aa'].value);   // Out: 10
console.log(bm.command['cmd3'].output.columns['aa'].value); // Out: 10
  • 컬럼 aa를 모든 뷰($all)에 설정합니다.

테이블 설정 예제

js
const bm = new BindModel();

// 명령 추가
bm.addCommand('cmd1');

// 테이블 추가
bm.addTable('second');

// 컬럼 추가
bm.columns.addValue('aa', 10); 
// 위와 동일
// bm.first.columns.addValue('aa', 10);
bm.second.columns.addValue('bb', 20);

// 컬럼 참조 설정
bm.command['cmd1'].setColumn(['aa', 'second.bb'], 'valid');

console.log(bm.command['cmd1'].valid.columns['aa'].value); // Out: 10
console.log(bm.command['cmd1'].valid.columns['bb'].value); // Out: 20
bm.cmd['cmd1'].valid.columns['aa'] === bm.first.columns['aa']  // true
bm.cmd['cmd1'].valid.columns['bb'] === bm.second.columns['bb'] // true
  • 첫 번째 테이블의 컬럼 aa와 두 번째 테이블의 컬럼 bb를 valid 뷰에 설정합니다.

release()#

지정된 뷰에서 컬럼 설정을 해제하는 메서드입니다.

ts
type ViewType = '$all' | 'valid' | 'bind' | 'output' | 'misc' | string;
declare function release(
    columnNames: string | string[],
    views: ViewType | ViewType[]
): void;
  • columnNames: 매핑을 해제할 컬럼의 이름 또는 이름 배열습니다.
  • views: 매핑을 해제할 뷰 이름 또는 이름 배열
    • '$all': 모든 뷰
    • 'valid': 유효성 검사를 위한 뷰
    • 'bind': 서버 요청 데이터를 위한 뷰
    • 'output': 응답 데이터를 매핑하는 뷰
    • 'misc': 추가적인 뷰
    • string[]: 사용자 정의 출력 뷰

release() 메서드는 컬럼 설정을 해제하는 메서드로, 지정된 뷰 또는 모든 뷰에 설정을 해제합니다.

  • 한 번의 호출로 여러 컬럼의 매핑을 동시에 해제할 수 있습니다.

Tip: release() 메서드는 뷰에서 참조된 컬럼을 간소화하여 해제하는 데 유용합니다.

js
const bm = new BindModel();

// 명령 추가
bm.addCommand('cmd1');

// 컬럼 추가
bm.columns.addValue('aa', 10);

// 컬럼 매핑
bm.command['cmd1'].setColumn('aa', '$all');

console.log(bm.command['cmd1'].valid.columns['aa'].value);  // Out: 10
console.log(bm.command['cmd1'].bind.columns['aa'].value);   // Out: 10
console.log(bm.command['cmd1'].output.columns['aa'].value); // Out: 10
console.log(bm.command['cmd1'].misc.columns['aa'].value);   // Out: 10

일부 컬럼 해제 예제

js
// 컬럼 해제
bm.command['cmd1'].release('aa', ['valid', 'bind']);

console.log(bm.command['cmd1'].output.columns['aa'].value); // 10
  • 특정 뷰(valid와 bind)에서 컬럼 aa의 참조값을 제거합니다.

모든 컬럼 해제 예제

js
// 컬럼 해제
bm.command['cmd1'].release('aa'); 
// 위와 동일
// bm.command['cmd1'].release('aa', '$all');

console.log(bm.command['cmd1'].valid.columns.count);  // Out: 0
console.log(bm.command['cmd1'].bind.columns.count);   // Out: 0
console.log(bm.command['cmd1'].output.columns.count); // Out: 0
console.log(bm.command['cmd1'].misc.columns.count);   // Out: 0
  • 모든 뷰에서 컬럼 aa의 참조값을 해제합니다.

newOutput()#

새로운 출력 뷰를 생성하는 메서드입니다.

ts
declare function newOutput(viewName?: string): void;
  • viewName(선택): 생성할 출력 뷰의 이름

newOutput() 메서드는 기본 출력 뷰 외에 추가적인 출력 뷰를 생성합니다.

  • 출력 뷰의 저장 위치는 _outputs 컬렉션입니다.
  • 기본 이름('output' + 순서)이 할당되며, 선택적으로 이름을 추가할 수 있습니다.
  • 뷰 이름은 현재 객체에 속성으로 추가되며, 예약어와 중복되지 않아야 합니다.

Tip: 응답 데이터를 분리하여 각 뷰에서 개별적으로 관리할 수 있습니다.

Tip: 예약어 목록 _baseTable, _output, _model, config, url, _guid, _type, $event, $KEYWORD, valid, bind, output, output1, misc

기본뷰 뷰 추가 예제

js
const bm = new BindModel();

// 명령 추가
bm.addCommand('cmd1');

bm.command['cmd1'].output === bm.command['cmd1'].output1 // true
  • 기본 출력 뷰(output)와 output1는 동일한 뷰입니다.

지정한 이름으로 뷰 추가 예제

js
const bm = new BindModel();

// 명령 추가
bm.addCommand('cmd1');

// 출력 뷰 추가
bm.command['cmd1'].newOutput('info');

bm.cmd['cmd1'].output2 === bm.cmd['cmd1'].info  // true
console.log(bm.command['cmd1'].info);          // [Object MetaView]
console.log(bm.command['cmd1'].output2);       // [Object MetaView]
  • 출력 뷰를 추가하고, output2 와 custormView 뷰를 확인합니다.

빈 이름으로 뷰 추가 예제

js
const bm = new BindModel();

// 명령 추가
bm.addCommand('cmd1');

// 출력 뷰 추가
bm.command['cmd1'].newOutput();

console.log(bm.command['cmd1'].output2); // [Object MetaView]
  • 이름을 지정하지 않고 출력 뷰를 추가하면,  output3 속성의 뷰만 할당됩니다.

removeOutput()#

특정 출력 뷰를 삭제하는 메서드입니다.

ts
declare function removeOutput(viewName: string): boolean;
  • viewName: 제거할 출력 뷰의 이름

removeOutput() 메서드는 명령에서 생성된 특정 출력 뷰를 제거합니다.

  • 지정이름과 함께 추가된 기본 이름은 같이 삭제됩니다.
js
const bm = new BindModel();

// 명령 추가
bm.addCommand('cmd1');

// 출력 뷰 추가
bm.command['cmd1'].newOutput('customView');

console.log(bm.command['cmd1'].customView); // [Object MetaView]
console.log(bm.command['cmd1'].output2);    // [Object MetaView]

// 출력 뷰 제거
bm.command['cmd1'].removeOutput('customView');

console.log(bm.command['cmd1'].customView); // Out: undefined
console.log(bm.command['cmd1'].output2);    // Out: undefined
  • 출력 뷰 customView를 생성한 후 제거하여 해당 뷰가 삭제되었는지 확인합니다.

이벤트#

onExecute#

명령(BindCommand)이 실행되기 전에 호출되는 이벤트 속성입니다.

ts
type onExecute = (model: BindModel, cmd: BindCommand) => void;
  • model: 실행 중인 BindModel 객체
  • cmd: 실행 중인 BindCommand 객체

onExecute는 명령이 실행되기 전에 호출되며, 실행 전 필요한 작업을 수행하는 이벤트입니다.

Tip : 이벤트 속성에 콜백함수를 설정하면, 기존 이벤트는 그대로 유지되며 새 이벤트가 추가됩니다.

js
const bm = new BindModel();

bm.addCommand('cmd1');

// 이벤트 등록
bm.command['cmd1'].onExecute = function(model, cmd) {
    console.log('Execute start...');
};

bm.command['cmd1'].execute();
  • 명령 실행 전에 콘솔에 'Execute...start' 메시지가 출력됩니다.

onExecuted#

명령(BindCommand)이 실행된 후 호출되는 이벤트 속성입니다.

ts
type onExecute = (model: BindModel, cmd: BindCommand) => void;
  • model: 실행 중인 BindModel 객체
  • cmd: 실행 중인 BindCommand 객체

onExecuted는 명령이 성공적으로 실행된 후 호출되며, 실행 후 작업을 수행하는 이벤트입니다.

Tip : 이벤트 속성에 콜백함수를 설정하면, 기존 이벤트는 그대로 유지되며 새 이벤트가 추가됩니다.

js
const bm = new BindModel();

bm.addCommand('cmd1');

// 이벤트 등록
bm.command['cmd1'].onExecuted = function(model, cmd) {
 console.log('Execute End...');
};

bm.command['cmd1'].execute();
  • 명령 실행 후 콘솔에 'Execute End...' 메시지가 출력됩니다.

검색어를 입력해 보세요.