0.1.4 • Published 6 years ago
localeworks.js v0.1.4
LocaleWorks
IGAWorks localization SDK.
소개
localeworks.js는 로컬라이제이션 번역을 도와주는 javascript library입니다.
해당 라이브러리는 아래 항목을 지원합니다.
- S3 버킷을 통한 번역본 배포 지원.
- Google 스프레드시트를 통한 번역본 배포 지원.
- 로컬 스토리지를 통한 캐시 지원
- 인터페이스를 통한 커스텀 로더 생성 가능 및 확장 사용 가능
API는 우측 링크에서 확인 가능합니다. documentation
설치
LocaleWorks는 패키지매니저를 통해 쉽게 설치가 가능합니다.
Javascript
$ npm install localeworks.js --save
Github에서 다운로드
$ git clone https://github.com/IGAWorksDev/localeworks.js.git
위 bash 명령어를 수행하시면, javascript의 원본 및 배포파일을 확인 하실 수 있습니다.
CDN에서 다운로드
일반 버전과 min
버전으로 나뉘며 별도로 폴리필을 사용중이실 때에는 nopolyfill
버전을 사용해주시길 바랍니다.
<script src="https://cdn.jsdelivr.net/npm/localeworks.js@0.1.4/dist/localeworks.js"></script>
<script src="https://cdn.jsdelivr.net/npm/localeworks.js@0.1.4/dist/localeworks.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/localeworks.js@0.1.4/dist/localeworks.nopolyfill.js"></script>
<script src="https://cdn.jsdelivr.net/npm/localeworks.js@0.1.4/dist/localeworks.nopolyfill.min.js"></script>
사용
Quick start
cdn와 같은 umd
으로 설치하신 경우 windows.localeworks
로 접근이 가능합니다.
const { S3LocaleLoader } = window.localeworks
const bucket = 'localization-ap-northeast-1'
const key = 'sample'
const loader = new S3LocaleLoader(bucket, key)
loader.getLocales().then(locales => {
// Do something
})
npm
을 통해 받으신 설치한 경우 아래와 같이 사용할 수 있습니다.
import { S3LocaleLoader } from 'localeworks.js'
const bucket = 'localization-ap-northeast-1'
const key = 'sample'
const loader = new S3LocaleLoader(bucket, key)
loader.getLocales().then(locales => {
// Do something
})
기본적으로 객체간의 조합을 통해 원하시는 형태의 모습으로 사용할 수 있습니다.
import {
S3LocaleLoader, CacheLoader, ReplacementExtension,
LocalStorageCacheStore, LanguageType
} from 'localeworks.js'
// initialize S3 Loader
const bucket = 'localization-ap-northeast-1'
const key = 'sample'
const loader = new S3LocaleLoader(bucket, key)
// initialize composite cache loader
const cacheOption = { cacheTime: 3000000 }
const cacheLoader = new CacheLoader([loader], cacheOption, new LocalStorageCacheStore())
// apply replacement extension
const replaceExt = new ReplacementExtension(cacheLoader)
replaceExt.apply(LanguageType.KO)