typesense js
v1.8.2
Typesense HTTP API에 액세스하기 위한 Javascript 클라이언트 라이브러리.
이 라이브러리는 서버측과 클라이언트측 모두에서 사용할 수 있습니다. 라이브러리의 소스는 ES6에 있으며 빌드 시 이를 ES5로 변환하고 두 개의 아티팩트를 생성합니다. 하나는 서버 측에서 사용할 수 있고 다른 하나는 Browserify를 사용하여 클라이언트 측에서 사용할 수 있습니다.
npm install --save typesense피어 종속성을 설치합니다.
npm install --save @babel/runtime 참고: @babel/runtime 은 많은 JS 라이브러리에서 매우 일반적인 종속성입니다. 따라서 각 라이브러리가 이를 독립적으로 종속성으로 추가하는 대신(이로 인해 @babel/runtime 의 여러 인스턴스가 설치되어 번들 크기가 증가함) 대신 Babel의 권장 사항은 라이브러리가 사용자에게 직접 종속성으로 한 번만 설치하도록 요청하는 것입니다. 전체 프로젝트에 대한 @babel/runtime 사본 1개. 어떤 경우에는 JS 프레임워크에 @babel/runtime 이미 종속성으로 포함되어 있을 수도 있습니다.
< script src =" dist/typesense.min.js " > </ script >또는 jsDelivr을 통해
< script src =" https://cdn.jsdelivr.net/npm/typesense@1/dist/typesense.min.js " > </ script > 자세한 예는 여기에서 설명서를 읽어보세요: https://typesense.org/docs/api/
테스트는 라이브러리가 내부적으로 어떻게 작동하는지 알 수 있는 좋은 장소이기도 합니다.
참고: 이 라이브러리를 브라우저에서 사용하는 경우 master API 키 대신 검색 작업만 허용하는 API 키를 반드시 사용하시기 바랍니다. 검색 전용 API 키를 생성하는 방법에 대한 예는 doc/examples/server/keys.js를 참조하세요.
모든 클라이언트 구성 옵션 목록은 Configuration.ts를 참조하세요.
다음은 클라이언트 사용 방법을 안내하는 인라인 주석이 포함된 몇 가지 예입니다: doc/examples
예제를 실행하려면 저장소 루트에서 다음을 수행하세요.
npm run typesenseServer
node doc/examples/server/bulkImport.js프레임워크로 GatsbyJS를 사용하는 경우 사이트를 구축할 때 사이트 데이터를 Typesense에 자동으로 푸시하는 플러그인(백그라운드에서 typeense-js를 사용하는)이 있습니다. 여기에서 자세히 알아보세요.
Firebase를 사용하는 경우 Firestore 데이터를 Typesense에 자동으로 푸시하는 Firebase 확장 프로그램(백그라운드에서 typeense-js를 사용함)이 있습니다. 여기에서 자세히 알아보세요.
강력한 인스턴트 검색 환경을 빠르게 구축하는 데 사용할 수 있는 UI 구성 요소에 대한 Typesense-InstantSearch.js(typesense-js 사용)를 확인하세요.
이 표는 서버=>클라이언트 호환성을 나타냅니다. 최신 버전의 클라이언트 라이브러리는 이전 버전의 서버 라이브러리와 역호환성을 유지합니다.
| 타입센스 서버 | TypeSense-js |
|---|---|
| >= v27.0.rc20 | >= v2.0.0 |
| >= v0.26.0.rc38 | >= v1.8.0 |
| >= v0.25.0 | >= v1.7.0 |
| >= v0.24.0 | >= v1.5.0 |
| >= v0.23.0 | >= v1.3.0 |
| >= v0.21.0 | >= v0.14.0 |
| >= v0.20.0 | >= v0.12.0 |
| >= v0.19.0 | >= v0.11.0 |
| >= v0.18.0 | >= v0.10.0 |
| >= v0.17.0 | >= v0.9.0 |
| >= v0.16.0 | >= v0.8.0 |
| >= v0.15.0 | >= v0.7.0 |
| >= v0.12.1 | >= v0.5.0 |
| >= v0.12.0 | >= v0.4.7 |
| <= v0.11 | <= v0.3.0 |
저장소를 확인한 후 npm install 실행하여 종속 항목을 설치하세요. 그런 다음 npm test 실행하여 linter와 테스트를 실행합니다.
새 버전을 출시하려면 np 패키지를 사용합니다.
$ npm install --global np
$ np
# Follow instructions that np shows you
버그 보고서 및 끌어오기 요청은 GitHub(https://github.com/typesense/typesense-js)에서 환영합니다.
