Skip to content

api

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

api

README.md

@ydbjs/api

The @ydbjs/api package provides TypeScript/JavaScript bindings for interacting with YDB services. It includes generated gRPC service definitions and protocol buffer types for various YDB APIs.

Features

  • gRPC service definitions for YDB APIs
  • Protocol buffer types for YDB entities
  • TypeScript support with type definitions

Installation

Install the package using npm:

npm install @ydbjs/api

Usage

Importing Services

import { DiscoveryServiceDefinition } from '@ydbjs/api/discovery'
import { CmsServiceDefinition } from '@ydbjs/api/cms'
import { QueryServiceDefinition } from '@ydbjs/api/query'

Example: Using a Service

import { createClientFactory, createChannel } from 'nice-grpc'
import { DiscoveryServiceDefinition } from '@ydbjs/api/discovery'

const clientFactory = createClientFactory()
const discoveryClient = clientFactory.create(
  DiscoveryServiceDefinition,
  createChannel('http://localhost:2136')
)

async function listEndpoints() {
  const response = await discoveryClient.listEndpoints({ database: '/local' })
  console.log(response)
}

listEndpoints().catch(console.error)

Using with @ydbjs/core

import { DiscoveryServiceDefinition } from '@ydbjs/api/discovery'
import { Driver } from '@ydbjs/core'

const driver = new Driver('grpc://localhost:2136')
const client = driver.createClient(DiscoveryServiceDefinition)
client.listEndpoints({ database: '/local' })

Development

Generating gRPC and Protocol Buffer Files

npm run generate

License

This project is licensed under the Apache 2.0 License.

Links