KurrentDB-Client-NodeJS
KurrentDB NodeJS Client
File Explorer
Download Latest Version (.zip)- .nvmrc
- bug_report.yml
- config.yml
- bump_versions.mjs
- benchmark.yml
- build-docs.yml
- cherry-pick-pr-for-label.yml
- load-configuration.yml
- main.yml
- qa.yml
- tests.yml
- theme.ts
- externalPlaceholders.ts
- log.ts
- types.ts
- version.ts
- versioning.ts
- index.ts
- index.ts
- createImportCodeBlockRule.ts
- importCodePlugin.ts
- normalizeWhitespace.ts
- resolveImportCode.ts
- types.ts
- resolver.ts
- types.ts
- Solina-Bold.woff
- Solina-Bold.woff2
- Solina-Light.woff
- Solina-Light.woff2
- Solina-Medium.woff
- Solina-Medium.woff2
- Solina-Regular.woff
- Solina-Regular.woff2
- snippet.js
- cloud.png
- favicon.ico
- favicon.png
- Kurrent Logo - Black.svg
- Kurrent Logo - Plum.svg
- Kurrent Logo - White.svg
- logo-white.png
- robots.txt
- video.png
- index.scss
- palette.scss
- client.ts
- config.ts
- appending-events.md
- authentication.md
- delete-stream.md
- getting-started.md
- observability.md
- persistent-subscriptions.md
- projections.md
- reading-events.md
- subscriptions.md
- .eslintignore
- .eslintrc.cjs
- .node-version
- package.json
- pnpm-lock.yaml
- tsconfig.json
- readStream.js
- readStream.js
- readStream.js
- docker-compose.yml
- load.js
- package.json
- README.md
- code_grpc_pb.js
- code_pb.d.ts
- code_pb.js
- gossip_grpc_pb.d.ts
- gossip_grpc_pb.js
- gossip_pb.d.ts
- gossip_pb.js
- operations_grpc_pb.d.ts
- operations_grpc_pb.js
- operations_pb.d.ts
- operations_pb.js
- persistentsubscriptions_grpc_pb.d.ts
- persistentsubscriptions_grpc_pb.js
- persistentsubscriptions_pb.d.ts
- persistentsubscriptions_pb.js
- projectionmanagement_grpc_pb.d.ts
- projectionmanagement_grpc_pb.js
- projectionmanagement_pb.d.ts
- projectionmanagement_pb.js
- serverfeatures_grpc_pb.d.ts
- serverfeatures_grpc_pb.js
- serverfeatures_pb.d.ts
- serverfeatures_pb.js
- shared_grpc_pb.js
- shared_pb.d.ts
- shared_pb.js
- status_grpc_pb.js
- status_pb.d.ts
- status_pb.js
- streams_grpc_pb.d.ts
- streams_grpc_pb.js
- streams_pb.d.ts
- streams_pb.js
- usermanagement_grpc_pb.d.ts
- usermanagement_grpc_pb.js
- usermanagement_pb.d.ts
- usermanagement_pb.js
- service_grpc_pb.d.ts
- service_grpc_pb.js
- service_pb.d.ts
- service_pb.js
- errors_grpc_pb.js
- errors_pb.d.ts
- errors_pb.js
- shared_grpc_pb.js
- shared_pb.d.ts
- shared_pb.js
- streams_grpc_pb.d.ts
- streams_grpc_pb.js
- streams_pb.d.ts
- streams_pb.js
- core_grpc_pb.js
- core_pb.d.ts
- core_pb.js
- errors_grpc_pb.js
- errors_pb.d.ts
- errors_pb.js
- rpc_grpc_pb.js
- rpc_pb.d.ts
- rpc_pb.js
- code.proto
- gossip.proto
- operations.proto
- persistentsubscriptions.proto
- projectionmanagement.proto
- serverfeatures.proto
- shared.proto
- status.proto
- streams.proto
- usermanagement.proto
- errors.proto
- streams.proto
- errors.proto
- rpc.proto
- discovery.ts
- http.ts
- index.ts
- parseConnectionString.ts
- ServerFeatures.ts
- binaryEvent.ts
- convertMetadata.ts
- index.ts
- jsonEvent.ts
- mapPersistentSubscriptionInfo.ts
- PersistentSubscriptionImpl.ts
- persistentSubscriptionSettings.ts
- settingsToGRPC.ts
- createPersistentSubscriptionToAll.ts
- createPersistentSubscriptionToStream.ts
- deletePersistentSubscriptionToAll.ts
- deletePersistentSubscriptionToStream.ts
- getPersistentSubscriptionToAllInfo.ts
- getPersistentSubscriptionToStreamInfo.ts
- index.ts
- listAllPersistentSubscriptions.ts
- listPersistentSubscriptionsToAll.ts
- listPersistentSubscriptionsToStream.ts
- replayParkedMessagesToAll.ts
- replayParkedMessagesToStream.ts
- restartPersistentSubscriptionSubsystem.ts
- subscribeToPersistentSubscriptionToAll.ts
- subscribeToPersistentSubscriptionToStream.ts
- updatePersistentSubscriptionToAll.ts
- updatePersistentSubscriptionToStream.ts
- mapGrpcProjectionDetails.ts
- createProjection.ts
- deleteProjection.ts
- disableProjection.ts
- enableProjection.ts
- getProjectionResult.ts
- getProjectionState.ts
- getProjectionStatus.ts
- index.ts
- listProjections.ts
- resetProjection.ts
- restartSubsystem.ts
- updateProjection.ts
- append.ts
- appendRecords.ts
- batchAppend.ts
- index.ts
- multiStreamAppend.ts
- unpackError.ts
- ReadStream.ts
- streamMetadata.ts
- Subscription.ts
- systemStreams.ts
- deleteStream.ts
- getStreamMetadata.ts
- index.ts
- readAll.ts
- readStream.ts
- setStreamMetadata.ts
- subscribeToAll.ts
- subscribeToStream.ts
- tombstoneStream.ts
- events.ts
- index.ts
- backpressuredWrite.ts
- CommandError.ts
- convertBridgeError.ts
- convertGrpcEvent.ts
- convertRustEvent.ts
- credentials.ts
- debug.ts
- filter.ts
- getGrpcStatusDetails.ts
- grpcStreamIdentifier.ts
- grpcUUID.ts
- index.ts
- isClientCancellationError.ts
- mapToValue.ts
- schema.ts
- utilityTypes.ts
- constants.ts
- index.ts
- CHANGELOG.md
- package.json
- README.md
- tsconfig.json
- attributes.ts
- index.ts
- instrumentation.ts
- types.ts
- utils.ts
- version.ts
- .gitignore
- CHANGELOG.md
- package.json
- README.md
- tsconfig.json
- keepAlive.test.ts.snap
- parseConnectionString.test.ts.snap
- tlsCAFile.test.ts.snap
- connectionStringTests.ts
- insecure-cluster.test.ts
- insecure-single-node.test.ts
- secure-cluster.test.ts
- secure-single-node.test.ts
- deadline-settings.test.ts.snap
- deadline-effects.test.ts
- deadline-settings.test.ts
- all-nodes-down.test.ts
- leader-failover.test.ts
- mid-stream.test.ts
- no-reconnection.test.ts
- NotLeaderError.test.ts
- UnavailableError.test.ts
- Channel.test.ts
- cluster.test.ts
- connectionName.test.ts
- defaultCredentials.test.ts
- determineBestNode.test.ts
- dns.test.ts
- insecure.test.ts
- keepAlive.test.ts
- not-leader.test.ts
- parseConnectionString.test.ts
- parseConnectionStringMockups.ts
- singleNode.test.ts
- tlsCAFile.test.ts
- tlsVerifyCert.test.ts
- tlsVerifyCertHttp.test.ts
- dispose.test.ts
- encoding.test.ts
- grpcUUID.test.ts
- http.test.ts
- http2-assertion-failure.test.ts
- oversize-event.test.ts
- RecordedEvent-created.test.ts
- typedEvents-more.test.ts
- typedEvents.test.ts
- write-after-end.test.ts
- instrumentation.test.ts
- createPersistentSubscriptionToAll.test.ts
- createPersistentSubscriptionToStream.test.ts
- deletePersistentSubscriptionToAll.test.ts
- deletePersistentSubscriptionToStream.test.ts
- getPersistentSubscriptionToAllInfo.test.ts
- getPersistentSubscriptionToStreamInfo.test.ts
- listAllPersistentSubscriptions.test.ts
- listPersistentSubscriptionsToAll.test.ts
- listPersistentSubscriptionsToStream.test.ts
- replayParkedMessagesToAll.test.ts
- replayParkedMessagesToStream.test.ts
- restartPersistentSubscriptionSubsystem.test.ts
- subscribeToPersistentSubscriptionToAll-filters.test.ts
- subscribeToPersistentSubscriptionToAll.test.ts
- subscribeToPersistentSubscriptionToStream.test.ts
- updatePersistentSubscriptionToAll.test.ts
- updatePersistentSubscriptionToStream.test.ts
- client-certificates.test.ts
- createProjection.test.ts
- deleteProjection.test.ts
- disableProjection.test.ts
- enableProjection.test.ts
- getProjectionResult.test.ts
- getProjectionState.test.ts
- getProjectionStatus.test.ts
- listProjections.test.ts
- resetProjection.test.ts
- restartSubsystem.test.ts
- updateProjection.test.ts
- appending-events.ts
- get-started.ts
- opentelemetry.ts
- persistent-subscriptions.ts
- projection-management.ts
- reading-events.ts
- server-side-filtering.ts
- subscribing-to-streams.ts
- user-certificates.ts
- appendRecords.test.ts
- appendToStream-batch-append-flood.test.ts
- appendToStream-batch-append.test.ts
- appendToStream-errors.test.ts
- appendToStream.test.ts
- deleteStream.test.ts
- getStreamMetadata.test.ts
- multiAppendStream.test.ts
- readAll.test.ts
- readStream.test.ts
- setStreamMetadata.test.ts
- subscribeToAll-filters.test.ts
- subscribeToAll.test.ts
- subscribeToStream.test.ts
- systemStreams.test.ts
- tombstoneStream.test.ts
- Cluster.ts
- collect.ts
- createManyPs.ts
- debug.ts
- Defer.ts
- delay.ts
- dockerImages.ts
- enableVersionCheck.ts
- FlakeFinder.js
- getCurrentConnection.ts
- index.ts
- matchServerVersion.ts
- optionalDescribe.ts
- postEventViaHttpApi.ts
- preflight.ts
- testEvents.ts
- .gitignore
- jest.config.js
- package.json
- README.md
- tsconfig.json
- .eslintignore
- .eslintrc.js
- .gitignore
- .prettierignore
- .yarnrc.yml
- CHANGELOG.md
- CONTRIBUTING.md
- KurrentLogo-Black.png
- KurrentLogo-Plum.png
- KurrentLogo-White.png
- LICENSE
- nx.json
- package.json
- README.md
- tsconfig.base.json
- yarn.lock
# Installation Guide
1. Get the code
git clone https://github.com/kurrent-io/KurrentDB-Client-NodeJS
Downloads the entire project code from GitHub to your computer.
cd KurrentDB-Client-NodeJS
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
โ ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker compose -f packages/benchmark/docker-compose.yml up -d --build
Runs the command against the services defined in the compose file.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Node.js
EasyPrerequisites
yarn install
Downloads and installs the libraries listed in package.json.
yarn build
Builds optimized production files.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)