@types/schema-registry
TypeScript icon, indicating that this package has built-in type declarations

1.17.3 • Public • Published

Installation

npm install --save @types/schema-registry

Summary

This package contains type definitions for schema-registry (https://github.com/nodefluent/schema-registry#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/schema-registry.

index.d.ts

/// <reference types="node" />
export interface RegistryClientConfig {
    host: string;
    port: number;
    protocol?: string | undefined;
    logger?: object | undefined;
    type?: string | undefined;
}

export interface AvroSchemaResponseInterface {
    subject: string;
    version: number;
    id: number;
    schema: any;
}

export type RegistryRequest = Promise<AvroSchemaResponseInterface>;

export class LivingAvroSchema extends RegistryClient {
    fetch: (poll?: boolean) => RegistryRequest;
    toBuffer: (object: object) => Buffer;
    fromBuffer: (buffer: Buffer) => any;
    on: (...args: any[]) => undefined;
    removeListener: (...args: any[]) => undefined;
    stop: () => undefined;
    constructor(subject: string, version: string, config: RegistryClientConfig);
}

export class RegistryClient {
    host: string;
    port: number;
    protocol: string;
    type: string;
    logger: object;

    request: (options: object, expectedStatusCode: number) => RegistryRequest;
    isAlive: () => RegistryRequest;
    registerSubjectVersion: (subject: string, schema: object) => RegistryRequest;
    getVersionsForSubject: (subject: string) => RegistryRequest;
    getConfig: () => RegistryRequest;
    setConfig: (config: object) => RegistryRequest;
    setSubjectConfig: (subject: string, config: object) => RegistryRequest;
    getSubjectConfig: (subject: string) => RegistryRequest;
    getSchemaById: (id: number) => RegistryRequest;
    getSubjects: () => RegistryRequest;
    getSubjectSchemaForVersion: (subject: string, version: number) => RegistryRequest;
    getLatestSubjectSchema: (subject: string) => RegistryRequest;
    checkSubjectRegistration: (subject: string, schema: object) => RegistryRequest;
    constructor(config: RegistryClientConfig);
}

Additional Details

  • Last updated: Tue, 07 Nov 2023 15:11:36 GMT
  • Dependencies: @types/node

Credits

These definitions were written by Tomislav Fabeta.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/schema-registry

Weekly Downloads

10

Version

1.17.3

License

MIT

Unpacked Size

6.24 kB

Total Files

5

Last publish

Collaborators

  • types