image
Akan.js
한국어
문서컨벤션레퍼런스Cheatsheet
image
Akan.js
Akan.js v2 문서가 새로 나왔습니다.v1 문서 보기
문서컨벤션레퍼런스Cheatsheet
MIT 라이선스 하에 배포되었습니다.
Akan.js 공식 컨설팅 서비스Akansoft
Copyright © 2026 Akan.js 모든 권리 보유.
시스템 관리자bassman
워크스페이스 규칙
• 구조
• 포맷 & 린트
앱 & 라이브러리 규칙
• 애셋 (public/ private/)
• 컴포넌트 (ui/)
• 서버 유틸리티 (srvkit/)
• 웹 유틸리티 (webkit/)
• 공통 유틸리티 (common/)
• akan.config.ts
도메인 규칙
• 개요
• model.constant.ts
• model.dictionary.ts
• model.document.ts
• model.service.ts
• model.signal.ts
• model.store.ts
• Model.Template.tsx
• Model.Unit.tsx
• Model.Util.tsx
• Model.View.tsx
• Model.Zone.tsx
스칼라 규칙
• 개요
• scalar.constant.ts
• scalar.dictionary.ts
• scalar.document.ts
• Scalar.Template.tsx
• Scalar.Unit.tsx
서비스 규칙
• 개요
• service.dictionary.ts
• service.service.ts
• service.signal.ts
• service.store.ts
• Service.Util.tsx
• Service.Zone.tsx
워크스페이스 규칙
• 구조
• 포맷 & 린트
앱 & 라이브러리 규칙
• 애셋 (public/ private/)
• 컴포넌트 (ui/)
• 서버 유틸리티 (srvkit/)
• 웹 유틸리티 (webkit/)
• 공통 유틸리티 (common/)
• akan.config.ts
도메인 규칙
• 개요
• model.constant.ts
• model.dictionary.ts
• model.document.ts
• model.service.ts
• model.signal.ts
• model.store.ts
• Model.Template.tsx
• Model.Unit.tsx
• Model.Util.tsx
• Model.View.tsx
• Model.Zone.tsx
스칼라 규칙
• 개요
• scalar.constant.ts
• scalar.dictionary.ts
• scalar.document.ts
• Scalar.Template.tsx
• Scalar.Unit.tsx
서비스 규칙
• 개요
• service.dictionary.ts
• service.service.ts
• service.signal.ts
• service.store.ts
• Service.Util.tsx
• Service.Zone.tsx
이전
service.service.ts
다음
service.store.ts

Signal 파일

Service module의 signal 파일은 service workflow를 외부로 노출합니다. client용 endpoint API, server용 internal task, worker용 cron job, model과 무관한 special route를 정의할 수 있습니다.
Signal은 여전히 `endpoint(srv.search, ...)`, `internal(srv.localFile, ...)`처럼 service module을 가리킵니다. service method는 service에, access shape은 signal에 둡니다.

Endpoint query

Service module endpoint는 model CRUD가 없어도 일반 typed query나 mutation이 될 수 있습니다. `_search` endpoint는 param과 search value를 받은 뒤 `searchService`를 호출합니다.
minimal query endpoint

Endpoint mutation

data 변경, token 생성, message 전송, side effect 실행 같은 service action에는 mutation을 사용합니다. endpoint는 얇게 유지하고 실제 작업은 service에 위임합니다.
minimal mutation endpoint

Internal과 cron

Internal signal은 browser UI에서 직접 호출하지 않는 server-side work에 사용합니다. Cron job은 server mode에 묶을 수 있고, batch service module에서 자주 사용합니다.
minimal cron

Custom route

Service endpoint는 `localFile/getBlob/*` 같은 custom path도 노출할 수 있습니다. raw request context가 필요하면 `Req`나 `Res`를 추가합니다.
prefixless endpoint
Signal 파일
Endpoint query
Endpoint mutation
Internal과 cron
Custom route