Class SchemaRegistryConnector

Description

Schema registry connector

Features:

connector manager for schema registry

Example

import { inject, container, Types, Core } from '@biorate/inversion';
import { IConfig, Config } from '@biorate/config';
import { IConnector } from '@biorate/connector';
import { SchemaRegistryConnector, ISchemaRegistryConnector } from '@biorate/schema-registry';

export class Root extends Core() {
  @inject(SchemaRegistryConnector) public connector: ISchemaRegistryConnector;
}

container.bind<IConfig>(Types.Config).to(Config).inSingletonScope();
container
  .bind<ISchemaRegistryConnector>(SchemaRegistryConnector)
  .toSelf()
  .inSingletonScope();
container.bind<Root>(Root).toSelf().inSingletonScope();

container.get<IConfig>(Types.Config).merge({
  SchemaRegistry: [{ name: 'connection', baseURL: 'http://localhost:8085' }],
});

(async () => {
  const root = container.get<Root>(Root);
  await root.$run();

  const { PostSubjectsVersions } = root.connector.connection('connection');
  const { data } = await PostSubjectsVersions.fetch({
    subject: 'test',
    schema: {
      type: 'record',
      name: 'Test',
      namespace: 'test',
      fields: [
        {
          name: 'firstName',
          type: 'string',
        },
        {
          name: 'lastName',
          type: 'string',
        },
        {
          name: 'age',
          type: 'int',
        },
      ],
    },
  });
  console.log(data); // { id: 1 }
})();

Hierarchy

Connector<ISchemaRegistryConfig, ISchemaRegistryConnection>
- SchemaRegistryConnector

Index

Constructors

constructor

new SchemaRegistryConnector(): SchemaRegistryConnector
Returns SchemaRegistryConnector

Inherited from Connector.constructor

Properties

`Private` #connections

#connections: Map<string, {
    decode: ((buffer) => Promise<any>);
    deleteSubjects: ((data) => Promise<AxiosResponse<number[], any>>);
    encode: ((subject, data, version?) => Promise<Buffer>);
    getSchemaBySubjectsAndVersion: ((data) => Promise<AxiosResponse<unknown, any>>);
    getSchemasById: ((id) => Promise<AxiosResponse<{
        schema: string;
    }, any>>);
    getSchemasTypes: (() => Promise<AxiosResponse<string[], any>>);
    getSchemasVersionsById: ((id) => Promise<AxiosResponse<{
        subject: string;
        version: number;
    }[], any>>);
    getSubjects: (() => Promise<AxiosResponse<string[], any>>);
    getSubjectsByVersion: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        schemaType: string;
        subject: string;
        version: number;
    }, any>>);
    getSubjectsVersions: ((subject) => Promise<AxiosResponse<number[], any>>);
    ping: (() => Promise<AxiosResponse<Record<string, unknown>, any>>);
    postSubjects: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        subject: string;
        version: number;
    }, any>>);
    postSubjectsVersions: ((data) => Promise<AxiosResponse<{
        id: number;
    }, any>>);
}>

Type declaration

decode: ((buffer) => Promise<any>)
- - (buffer): Promise<any>
  - Parameters
    - buffer: Buffer
    Returns Promise<any>
deleteSubjects: ((data) => Promise<AxiosResponse<number[], any>>)
- - (data): Promise<AxiosResponse<number[], any>>
  - Parameters
    - data: {
      permanent?: boolean;
      subject: string;
      }
      
      Optional permanent?: boolean
      
      subject: string
    Returns Promise<AxiosResponse<number[], any>>
encode: ((subject, data, version?) => Promise<Buffer>)
- - (subject, data, version?): Promise<Buffer>
  - Parameters
    - subject: string
    - data: Record<string, any>
    - version: string | number = 'latest'
    Returns Promise<Buffer>
getSchemaBySubjectsAndVersion: ((data) => Promise<AxiosResponse<unknown, any>>)
- - (data): Promise<AxiosResponse<unknown, any>>
  - Parameters
    - data: {
      subject: string;
      version: string | number;
      }
      
      subject: string
      
      version: string | number
    Returns Promise<AxiosResponse<unknown, any>>
getSchemasById: ((id) => Promise<AxiosResponse<{
schema: string;
}, any>>)
- - (id): Promise<AxiosResponse<{
    schema: string;
    }, any>>
  - Parameters
    - id: number
    Returns Promise<AxiosResponse<{
    schema: string;
    }, any>>
getSchemasTypes: (() => Promise<AxiosResponse<string[], any>>)
- - (): Promise<AxiosResponse<string[], any>>
  - Returns Promise<AxiosResponse<string[], any>>
getSchemasVersionsById: ((id) => Promise<AxiosResponse<{
subject: string;
version: number;
}[], any>>)
- - (id): Promise<AxiosResponse<{
    subject: string;
    version: number;
    }[], any>>
  - Parameters
    - id: number
    Returns Promise<AxiosResponse<{
    subject: string;
    version: number;
    }[], any>>
getSubjects: (() => Promise<AxiosResponse<string[], any>>)
- - (): Promise<AxiosResponse<string[], any>>
  - Returns Promise<AxiosResponse<string[], any>>
getSubjectsByVersion: ((data) => Promise<AxiosResponse<{
    id: number;
    schema: string;
    schemaType: string;
    subject: string;
    version: number;
}, any>>)
- - (data): Promise<AxiosResponse<{
        id: number;
        schema: string;
        schemaType: string;
        subject: string;
        version: number;
    }, any>>
  - Parameters
    - data: {
      subject: string;
      version: string | number;
      }
      
      subject: string
      
      version: string | number
    Returns Promise<AxiosResponse<{
        id: number;
        schema: string;
        schemaType: string;
        subject: string;
        version: number;
    }, any>>
getSubjectsVersions: ((subject) => Promise<AxiosResponse<number[], any>>)
- - (subject): Promise<AxiosResponse<number[], any>>
  - Parameters
    - subject: string
    Returns Promise<AxiosResponse<number[], any>>
ping: (() => Promise<AxiosResponse<Record<string, unknown>, any>>)
- - (): Promise<AxiosResponse<Record<string, unknown>, any>>
  - Returns Promise<AxiosResponse<Record<string, unknown>, any>>
postSubjects: ((data) => Promise<AxiosResponse<{
    id: number;
    schema: string;
    subject: string;
    version: number;
}, any>>)
- - (data): Promise<AxiosResponse<{
        id: number;
        schema: string;
        subject: string;
        version: number;
    }, any>>
  - Parameters
    - data: {
          normalize?: boolean;
          reference?: string;
          schema: string | Record<string, any>;
          schemaType?: string;
          subject: string;
      }
      
      Optional normalize?: boolean
      
      Optional reference?: string
      
      schema: string | Record<string, any>
      
      Optional schemaType?: string
      
      subject: string
    Returns Promise<AxiosResponse<{
        id: number;
        schema: string;
        subject: string;
        version: number;
    }, any>>
postSubjectsVersions: ((data) => Promise<AxiosResponse<{
id: number;
}, any>>)
- - (data): Promise<AxiosResponse<{
    id: number;
    }, any>>
  - Parameters
    - data: {
          normalize?: boolean;
          reference?: string;
          schema: string | Record<string, any>;
          schemaType?: string;
          subject: string;
      }
      
      Optional normalize?: boolean
      
      Optional reference?: string
      
      schema: string | Record<string, any>
      
      Optional schemaType?: string
      
      subject: string
    Returns Promise<AxiosResponse<{
    id: number;
    }, any>>

Description

Private connections storage

`Private` #connections

Type declaration

decode: ((buffer) => Promise<any>)
- - (buffer): Promise<any>
  - Parameters
    - buffer: Buffer
    Returns Promise<any>
deleteSubjects: ((data) => Promise<AxiosResponse<number[], any>>)
- - (data): Promise<AxiosResponse<number[], any>>
  - Parameters
    - data: {
      permanent?: boolean;
      subject: string;
      }
      
      Optional permanent?: boolean
      
      subject: string
    Returns Promise<AxiosResponse<number[], any>>
encode: ((subject, data, version?) => Promise<Buffer>)
- - (subject, data, version?): Promise<Buffer>
  - Parameters
    - subject: string
    - data: Record<string, any>
    - version: string | number = 'latest'
    Returns Promise<Buffer>
getSchemaBySubjectsAndVersion: ((data) => Promise<AxiosResponse<unknown, any>>)
- - (data): Promise<AxiosResponse<unknown, any>>
  - Parameters
    - data: {
      subject: string;
      version: string | number;
      }
      
      subject: string
      
      version: string | number
    Returns Promise<AxiosResponse<unknown, any>>
getSchemasById: ((id) => Promise<AxiosResponse<{
schema: string;
}, any>>)
- - (id): Promise<AxiosResponse<{
    schema: string;
    }, any>>
  - Parameters
    - id: number
    Returns Promise<AxiosResponse<{
    schema: string;
    }, any>>
getSchemasTypes: (() => Promise<AxiosResponse<string[], any>>)
- - (): Promise<AxiosResponse<string[], any>>
  - Returns Promise<AxiosResponse<string[], any>>
getSchemasVersionsById: ((id) => Promise<AxiosResponse<{
subject: string;
version: number;
}[], any>>)
- - (id): Promise<AxiosResponse<{
    subject: string;
    version: number;
    }[], any>>
  - Parameters
    - id: number
    Returns Promise<AxiosResponse<{
    subject: string;
    version: number;
    }[], any>>
getSubjects: (() => Promise<AxiosResponse<string[], any>>)
- - (): Promise<AxiosResponse<string[], any>>
  - Returns Promise<AxiosResponse<string[], any>>
getSubjectsByVersion: ((data) => Promise<AxiosResponse<{
    id: number;
    schema: string;
    schemaType: string;
    subject: string;
    version: number;
}, any>>)
- - (data): Promise<AxiosResponse<{
        id: number;
        schema: string;
        schemaType: string;
        subject: string;
        version: number;
    }, any>>
  - Parameters
    - data: {
      subject: string;
      version: string | number;
      }
      
      subject: string
      
      version: string | number
    Returns Promise<AxiosResponse<{
        id: number;
        schema: string;
        schemaType: string;
        subject: string;
        version: number;
    }, any>>
getSubjectsVersions: ((subject) => Promise<AxiosResponse<number[], any>>)
- - (subject): Promise<AxiosResponse<number[], any>>
  - Parameters
    - subject: string
    Returns Promise<AxiosResponse<number[], any>>
ping: (() => Promise<AxiosResponse<Record<string, unknown>, any>>)
- - (): Promise<AxiosResponse<Record<string, unknown>, any>>
  - Returns Promise<AxiosResponse<Record<string, unknown>, any>>
postSubjects: ((data) => Promise<AxiosResponse<{
    id: number;
    schema: string;
    subject: string;
    version: number;
}, any>>)
- - (data): Promise<AxiosResponse<{
        id: number;
        schema: string;
        subject: string;
        version: number;
    }, any>>
  - Parameters
    - data: {
          normalize?: boolean;
          reference?: string;
          schema: string | Record<string, any>;
          schemaType?: string;
          subject: string;
      }
      
      Optional normalize?: boolean
      
      Optional reference?: string
      
      schema: string | Record<string, any>
      
      Optional schemaType?: string
      
      subject: string
    Returns Promise<AxiosResponse<{
        id: number;
        schema: string;
        subject: string;
        version: number;
    }, any>>
postSubjectsVersions: ((data) => Promise<AxiosResponse<{
id: number;
}, any>>)
- - (data): Promise<AxiosResponse<{
    id: number;
    }, any>>
  - Parameters
    - data: {
          normalize?: boolean;
          reference?: string;
          schema: string | Record<string, any>;
          schemaType?: string;
          subject: string;
      }
      
      Optional normalize?: boolean
      
      Optional reference?: string
      
      schema: string | Record<string, any>
      
      Optional schemaType?: string
      
      subject: string
    Returns Promise<AxiosResponse<{
    id: number;
    }, any>>

Description

Private connections storage

`Private` #current

#current: {
    decode: ((buffer) => Promise<any>);
    deleteSubjects: ((data) => Promise<AxiosResponse<number[], any>>);
    encode: ((subject, data, version?) => Promise<Buffer>);
    getSchemaBySubjectsAndVersion: ((data) => Promise<AxiosResponse<unknown, any>>);
    getSchemasById: ((id) => Promise<AxiosResponse<{
        schema: string;
    }, any>>);
    getSchemasTypes: (() => Promise<AxiosResponse<string[], any>>);
    getSchemasVersionsById: ((id) => Promise<AxiosResponse<{
        subject: string;
        version: number;
    }[], any>>);
    getSubjects: (() => Promise<AxiosResponse<string[], any>>);
    getSubjectsByVersion: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        schemaType: string;
        subject: string;
        version: number;
    }, any>>);
    getSubjectsVersions: ((subject) => Promise<AxiosResponse<number[], any>>);
    ping: (() => Promise<AxiosResponse<Record<string, unknown>, any>>);
    postSubjects: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        subject: string;
        version: number;
    }, any>>);
    postSubjectsVersions: ((data) => Promise<AxiosResponse<{
        id: number;
    }, any>>);
}

Type declaration

decode: ((buffer) => Promise<any>)
- - (buffer): Promise<any>
  - Parameters
    - buffer: Buffer
    Returns Promise<any>
deleteSubjects: ((data) => Promise<AxiosResponse<number[], any>>)
- - (data): Promise<AxiosResponse<number[], any>>
  - Parameters
    - data: {
      permanent?: boolean;
      subject: string;
      }
      
      Optional permanent?: boolean
      
      subject: string
    Returns Promise<AxiosResponse<number[], any>>
encode: ((subject, data, version?) => Promise<Buffer>)
- - (subject, data, version?): Promise<Buffer>
  - Parameters
    - subject: string
    - data: Record<string, any>
    - version: string | number = 'latest'
    Returns Promise<Buffer>
getSchemaBySubjectsAndVersion: ((data) => Promise<AxiosResponse<unknown, any>>)
- - (data): Promise<AxiosResponse<unknown, any>>
  - Parameters
    - data: {
      subject: string;
      version: string | number;
      }
      
      subject: string
      
      version: string | number
    Returns Promise<AxiosResponse<unknown, any>>
getSchemasById: ((id) => Promise<AxiosResponse<{
schema: string;
}, any>>)
- - (id): Promise<AxiosResponse<{
    schema: string;
    }, any>>
  - Parameters
    - id: number
    Returns Promise<AxiosResponse<{
    schema: string;
    }, any>>
getSchemasTypes: (() => Promise<AxiosResponse<string[], any>>)
- - (): Promise<AxiosResponse<string[], any>>
  - Returns Promise<AxiosResponse<string[], any>>
getSchemasVersionsById: ((id) => Promise<AxiosResponse<{
subject: string;
version: number;
}[], any>>)
- - (id): Promise<AxiosResponse<{
    subject: string;
    version: number;
    }[], any>>
  - Parameters
    - id: number
    Returns Promise<AxiosResponse<{
    subject: string;
    version: number;
    }[], any>>
getSubjects: (() => Promise<AxiosResponse<string[], any>>)
- - (): Promise<AxiosResponse<string[], any>>
  - Returns Promise<AxiosResponse<string[], any>>
getSubjectsByVersion: ((data) => Promise<AxiosResponse<{
    id: number;
    schema: string;
    schemaType: string;
    subject: string;
    version: number;
}, any>>)
- - (data): Promise<AxiosResponse<{
        id: number;
        schema: string;
        schemaType: string;
        subject: string;
        version: number;
    }, any>>
  - Parameters
    - data: {
      subject: string;
      version: string | number;
      }
      
      subject: string
      
      version: string | number
    Returns Promise<AxiosResponse<{
        id: number;
        schema: string;
        schemaType: string;
        subject: string;
        version: number;
    }, any>>
getSubjectsVersions: ((subject) => Promise<AxiosResponse<number[], any>>)
- - (subject): Promise<AxiosResponse<number[], any>>
  - Parameters
    - subject: string
    Returns Promise<AxiosResponse<number[], any>>
ping: (() => Promise<AxiosResponse<Record<string, unknown>, any>>)
- - (): Promise<AxiosResponse<Record<string, unknown>, any>>
  - Returns Promise<AxiosResponse<Record<string, unknown>, any>>
postSubjects: ((data) => Promise<AxiosResponse<{
    id: number;
    schema: string;
    subject: string;
    version: number;
}, any>>)
- - (data): Promise<AxiosResponse<{
        id: number;
        schema: string;
        subject: string;
        version: number;
    }, any>>
  - Parameters
    - data: {
          normalize?: boolean;
          reference?: string;
          schema: string | Record<string, any>;
          schemaType?: string;
          subject: string;
      }
      
      Optional normalize?: boolean
      
      Optional reference?: string
      
      schema: string | Record<string, any>
      
      Optional schemaType?: string
      
      subject: string
    Returns Promise<AxiosResponse<{
        id: number;
        schema: string;
        subject: string;
        version: number;
    }, any>>
postSubjectsVersions: ((data) => Promise<AxiosResponse<{
id: number;
}, any>>)
- - (data): Promise<AxiosResponse<{
    id: number;
    }, any>>
  - Parameters
    - data: {
          normalize?: boolean;
          reference?: string;
          schema: string | Record<string, any>;
          schemaType?: string;
          subject: string;
      }
      
      Optional normalize?: boolean
      
      Optional reference?: string
      
      schema: string | Record<string, any>
      
      Optional schemaType?: string
      
      subject: string
    Returns Promise<AxiosResponse<{
    id: number;
    }, any>>

Description

Private link to selected (used) connection

`Private` #current

Type declaration

decode: ((buffer) => Promise<any>)
- - (buffer): Promise<any>
  - Parameters
    - buffer: Buffer
    Returns Promise<any>
deleteSubjects: ((data) => Promise<AxiosResponse<number[], any>>)
- - (data): Promise<AxiosResponse<number[], any>>
  - Parameters
    - data: {
      permanent?: boolean;
      subject: string;
      }
      
      Optional permanent?: boolean
      
      subject: string
    Returns Promise<AxiosResponse<number[], any>>
encode: ((subject, data, version?) => Promise<Buffer>)
- - (subject, data, version?): Promise<Buffer>
  - Parameters
    - subject: string
    - data: Record<string, any>
    - version: string | number = 'latest'
    Returns Promise<Buffer>
getSchemaBySubjectsAndVersion: ((data) => Promise<AxiosResponse<unknown, any>>)
- - (data): Promise<AxiosResponse<unknown, any>>
  - Parameters
    - data: {
      subject: string;
      version: string | number;
      }
      
      subject: string
      
      version: string | number
    Returns Promise<AxiosResponse<unknown, any>>
getSchemasById: ((id) => Promise<AxiosResponse<{
schema: string;
}, any>>)
- - (id): Promise<AxiosResponse<{
    schema: string;
    }, any>>
  - Parameters
    - id: number
    Returns Promise<AxiosResponse<{
    schema: string;
    }, any>>
getSchemasTypes: (() => Promise<AxiosResponse<string[], any>>)
- - (): Promise<AxiosResponse<string[], any>>
  - Returns Promise<AxiosResponse<string[], any>>
getSchemasVersionsById: ((id) => Promise<AxiosResponse<{
subject: string;
version: number;
}[], any>>)
- - (id): Promise<AxiosResponse<{
    subject: string;
    version: number;
    }[], any>>
  - Parameters
    - id: number
    Returns Promise<AxiosResponse<{
    subject: string;
    version: number;
    }[], any>>
getSubjects: (() => Promise<AxiosResponse<string[], any>>)
- - (): Promise<AxiosResponse<string[], any>>
  - Returns Promise<AxiosResponse<string[], any>>
getSubjectsByVersion: ((data) => Promise<AxiosResponse<{
    id: number;
    schema: string;
    schemaType: string;
    subject: string;
    version: number;
}, any>>)
- - (data): Promise<AxiosResponse<{
        id: number;
        schema: string;
        schemaType: string;
        subject: string;
        version: number;
    }, any>>
  - Parameters
    - data: {
      subject: string;
      version: string | number;
      }
      
      subject: string
      
      version: string | number
    Returns Promise<AxiosResponse<{
        id: number;
        schema: string;
        schemaType: string;
        subject: string;
        version: number;
    }, any>>
getSubjectsVersions: ((subject) => Promise<AxiosResponse<number[], any>>)
- - (subject): Promise<AxiosResponse<number[], any>>
  - Parameters
    - subject: string
    Returns Promise<AxiosResponse<number[], any>>
ping: (() => Promise<AxiosResponse<Record<string, unknown>, any>>)
- - (): Promise<AxiosResponse<Record<string, unknown>, any>>
  - Returns Promise<AxiosResponse<Record<string, unknown>, any>>
postSubjects: ((data) => Promise<AxiosResponse<{
    id: number;
    schema: string;
    subject: string;
    version: number;
}, any>>)
- - (data): Promise<AxiosResponse<{
        id: number;
        schema: string;
        subject: string;
        version: number;
    }, any>>
  - Parameters
    - data: {
          normalize?: boolean;
          reference?: string;
          schema: string | Record<string, any>;
          schemaType?: string;
          subject: string;
      }
      
      Optional normalize?: boolean
      
      Optional reference?: string
      
      schema: string | Record<string, any>
      
      Optional schemaType?: string
      
      subject: string
    Returns Promise<AxiosResponse<{
        id: number;
        schema: string;
        subject: string;
        version: number;
    }, any>>
postSubjectsVersions: ((data) => Promise<AxiosResponse<{
id: number;
}, any>>)
- - (data): Promise<AxiosResponse<{
    id: number;
    }, any>>
  - Parameters
    - data: {
          normalize?: boolean;
          reference?: string;
          schema: string | Record<string, any>;
          schemaType?: string;
          subject: string;
      }
      
      Optional normalize?: boolean
      
      Optional reference?: string
      
      schema: string | Record<string, any>
      
      Optional schemaType?: string
      
      subject: string
    Returns Promise<AxiosResponse<{
    id: number;
    }, any>>

Description

Private link to selected (used) connection

`Protected` config

config: IConfig

Description

Config dependency

`Protected` `Readonly` namespace

namespace: "SchemaRegistry" = 'SchemaRegistry'

Description

Namespace path for fetching configuration

Accessors

connections

get connections(): Map<string, T>
Returns Map<string, T>

Description
Connections storage
Inherited from Connector.connections
- Defined in packages/@biorate/connector/src/index.ts:81

current

get current(): T
Returns T

Description
Link to selected (used) connection
Inherited from Connector.current
- Defined in packages/@biorate/connector/src/index.ts:87

Methods

`Protected` connect

connect(config): Promise<{
    decode: ((buffer) => Promise<any>);
    deleteSubjects: ((data) => Promise<AxiosResponse<number[], any>>);
    encode: ((subject, data, version?) => Promise<Buffer>);
    getSchemaBySubjectsAndVersion: ((data) => Promise<AxiosResponse<unknown, any>>);
    getSchemasById: ((id) => Promise<AxiosResponse<{
        schema: string;
    }, any>>);
    getSchemasTypes: (() => Promise<AxiosResponse<string[], any>>);
    getSchemasVersionsById: ((id) => Promise<AxiosResponse<{
        subject: string;
        version: number;
    }[], any>>);
    getSubjects: (() => Promise<AxiosResponse<string[], any>>);
    getSubjectsByVersion: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        schemaType: string;
        subject: string;
        version: number;
    }, any>>);
    getSubjectsVersions: ((subject) => Promise<AxiosResponse<number[], any>>);
    ping: (() => Promise<AxiosResponse<Record<string, unknown>, any>>);
    postSubjects: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        subject: string;
        version: number;
    }, any>>);
    postSubjectsVersions: ((data) => Promise<AxiosResponse<{
        id: number;
    }, any>>);
}>
Parameters
- config: ISchemaRegistryConfig
Returns Promise<{
    decode: ((buffer) => Promise<any>);
    deleteSubjects: ((data) => Promise<AxiosResponse<number[], any>>);
    encode: ((subject, data, version?) => Promise<Buffer>);
    getSchemaBySubjectsAndVersion: ((data) => Promise<AxiosResponse<unknown, any>>);
    getSchemasById: ((id) => Promise<AxiosResponse<{
        schema: string;
    }, any>>);
    getSchemasTypes: (() => Promise<AxiosResponse<string[], any>>);
    getSchemasVersionsById: ((id) => Promise<AxiosResponse<{
        subject: string;
        version: number;
    }[], any>>);
    getSubjects: (() => Promise<AxiosResponse<string[], any>>);
    getSubjectsByVersion: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        schemaType: string;
        subject: string;
        version: number;
    }, any>>);
    getSubjectsVersions: ((subject) => Promise<AxiosResponse<number[], any>>);
    ping: (() => Promise<AxiosResponse<Record<string, unknown>, any>>);
    postSubjects: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        subject: string;
        version: number;
    }, any>>);
    postSubjectsVersions: ((data) => Promise<AxiosResponse<{
        id: number;
    }, any>>);
}>

Description
Create connection
Overrides Connector.connect
- Defined in packages/@biorate/schema-registry/src/index.ts:89

connection

connection(name?): {
    decode: ((buffer) => Promise<any>);
    deleteSubjects: ((data) => Promise<AxiosResponse<number[], any>>);
    encode: ((subject, data, version?) => Promise<Buffer>);
    getSchemaBySubjectsAndVersion: ((data) => Promise<AxiosResponse<unknown, any>>);
    getSchemasById: ((id) => Promise<AxiosResponse<{
        schema: string;
    }, any>>);
    getSchemasTypes: (() => Promise<AxiosResponse<string[], any>>);
    getSchemasVersionsById: ((id) => Promise<AxiosResponse<{
        subject: string;
        version: number;
    }[], any>>);
    getSubjects: (() => Promise<AxiosResponse<string[], any>>);
    getSubjectsByVersion: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        schemaType: string;
        subject: string;
        version: number;
    }, any>>);
    getSubjectsVersions: ((subject) => Promise<AxiosResponse<number[], any>>);
    ping: (() => Promise<AxiosResponse<Record<string, unknown>, any>>);
    postSubjects: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        subject: string;
        version: number;
    }, any>>);
    postSubjectsVersions: ((data) => Promise<AxiosResponse<{
        id: number;
    }, any>>);
}
Parameters
- Optional name: string
  Optional
Returns {
    decode: ((buffer) => Promise<any>);
    deleteSubjects: ((data) => Promise<AxiosResponse<number[], any>>);
    encode: ((subject, data, version?) => Promise<Buffer>);
    getSchemaBySubjectsAndVersion: ((data) => Promise<AxiosResponse<unknown, any>>);
    getSchemasById: ((id) => Promise<AxiosResponse<{
        schema: string;
    }, any>>);
    getSchemasTypes: (() => Promise<AxiosResponse<string[], any>>);
    getSchemasVersionsById: ((id) => Promise<AxiosResponse<{
        subject: string;
        version: number;
    }[], any>>);
    getSubjects: (() => Promise<AxiosResponse<string[], any>>);
    getSubjectsByVersion: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        schemaType: string;
        subject: string;
        version: number;
    }, any>>);
    getSubjectsVersions: ((subject) => Promise<AxiosResponse<number[], any>>);
    ping: (() => Promise<AxiosResponse<Record<string, unknown>, any>>);
    postSubjects: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        subject: string;
        version: number;
    }, any>>);
    postSubjectsVersions: ((data) => Promise<AxiosResponse<{
        id: number;
    }, any>>);
}
- decode: ((buffer) => Promise<any>)
  - - (buffer): Promise<any>
    - Parameters
      
      buffer: Buffer
      Returns Promise<any>
- deleteSubjects: ((data) => Promise<AxiosResponse<number[], any>>)
  - - (data): Promise<AxiosResponse<number[], any>>
    - Parameters
      
      data: {
      permanent?: boolean;
      subject: string;
      }
      
      Optional permanent?: boolean
      
      subject: string
      Returns Promise<AxiosResponse<number[], any>>
- encode: ((subject, data, version?) => Promise<Buffer>)
  - - (subject, data, version?): Promise<Buffer>
    - Parameters
      
      subject: string
      
      data: Record<string, any>
      
      version: string | number = 'latest'
      Returns Promise<Buffer>
- getSchemaBySubjectsAndVersion: ((data) => Promise<AxiosResponse<unknown, any>>)
  - - (data): Promise<AxiosResponse<unknown, any>>
    - Parameters
      
      data: {
      subject: string;
      version: string | number;
      }
      
      subject: string
      
      version: string | number
      Returns Promise<AxiosResponse<unknown, any>>
- getSchemasById: ((id) => Promise<AxiosResponse<{
  schema: string;
  }, any>>)
  - - (id): Promise<AxiosResponse<{
      schema: string;
      }, any>>
    - Parameters
      
      id: number
      Returns Promise<AxiosResponse<{
      schema: string;
      }, any>>
- getSchemasTypes: (() => Promise<AxiosResponse<string[], any>>)
  - - (): Promise<AxiosResponse<string[], any>>
    - Returns Promise<AxiosResponse<string[], any>>
- getSchemasVersionsById: ((id) => Promise<AxiosResponse<{
  subject: string;
  version: number;
  }[], any>>)
  - - (id): Promise<AxiosResponse<{
      subject: string;
      version: number;
      }[], any>>
    - Parameters
      
      id: number
      Returns Promise<AxiosResponse<{
      subject: string;
      version: number;
      }[], any>>
- getSubjects: (() => Promise<AxiosResponse<string[], any>>)
  - - (): Promise<AxiosResponse<string[], any>>
    - Returns Promise<AxiosResponse<string[], any>>
- getSubjectsByVersion: ((data) => Promise<AxiosResponse<{
      id: number;
      schema: string;
      schemaType: string;
      subject: string;
      version: number;
  }, any>>)
  - - (data): Promise<AxiosResponse<{
          id: number;
          schema: string;
          schemaType: string;
          subject: string;
          version: number;
      }, any>>
    - Parameters
      
      data: {
      subject: string;
      version: string | number;
      }
      
      subject: string
      
      version: string | number
      Returns Promise<AxiosResponse<{
          id: number;
          schema: string;
          schemaType: string;
          subject: string;
          version: number;
      }, any>>
- getSubjectsVersions: ((subject) => Promise<AxiosResponse<number[], any>>)
  - - (subject): Promise<AxiosResponse<number[], any>>
    - Parameters
      
      subject: string
      Returns Promise<AxiosResponse<number[], any>>
- ping: (() => Promise<AxiosResponse<Record<string, unknown>, any>>)
  - - (): Promise<AxiosResponse<Record<string, unknown>, any>>
    - Returns Promise<AxiosResponse<Record<string, unknown>, any>>
- postSubjects: ((data) => Promise<AxiosResponse<{
      id: number;
      schema: string;
      subject: string;
      version: number;
  }, any>>)
  - - (data): Promise<AxiosResponse<{
          id: number;
          schema: string;
          subject: string;
          version: number;
      }, any>>
    - Parameters
      
      data: {
          normalize?: boolean;
          reference?: string;
          schema: string | Record<string, any>;
          schemaType?: string;
          subject: string;
      }
      
      Optional normalize?: boolean
      
      Optional reference?: string
      
      schema: string | Record<string, any>
      
      Optional schemaType?: string
      
      subject: string
      Returns Promise<AxiosResponse<{
          id: number;
          schema: string;
          subject: string;
          version: number;
      }, any>>
- postSubjectsVersions: ((data) => Promise<AxiosResponse<{
  id: number;
  }, any>>)
  - - (data): Promise<AxiosResponse<{
      id: number;
      }, any>>
    - Parameters
      
      data: {
          normalize?: boolean;
          reference?: string;
          schema: string | Record<string, any>;
          schemaType?: string;
          subject: string;
      }
      
      Optional normalize?: boolean
      
      Optional reference?: string
      
      schema: string | Record<string, any>
      
      Optional schemaType?: string
      
      subject: string
      Returns Promise<AxiosResponse<{
      id: number;
      }, any>>
Description
Method for get existed the connection
Inherited from Connector.connection
- Defined in packages/@biorate/connector/src/index.ts:113

create

create(config): Promise<{
    decode: ((buffer) => Promise<any>);
    deleteSubjects: ((data) => Promise<AxiosResponse<number[], any>>);
    encode: ((subject, data, version?) => Promise<Buffer>);
    getSchemaBySubjectsAndVersion: ((data) => Promise<AxiosResponse<unknown, any>>);
    getSchemasById: ((id) => Promise<AxiosResponse<{
        schema: string;
    }, any>>);
    getSchemasTypes: (() => Promise<AxiosResponse<string[], any>>);
    getSchemasVersionsById: ((id) => Promise<AxiosResponse<{
        subject: string;
        version: number;
    }[], any>>);
    getSubjects: (() => Promise<AxiosResponse<string[], any>>);
    getSubjectsByVersion: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        schemaType: string;
        subject: string;
        version: number;
    }, any>>);
    getSubjectsVersions: ((subject) => Promise<AxiosResponse<number[], any>>);
    ping: (() => Promise<AxiosResponse<Record<string, unknown>, any>>);
    postSubjects: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        subject: string;
        version: number;
    }, any>>);
    postSubjectsVersions: ((data) => Promise<AxiosResponse<{
        id: number;
    }, any>>);
}>
Parameters
- config: ISchemaRegistryConfig
Returns Promise<{
    decode: ((buffer) => Promise<any>);
    deleteSubjects: ((data) => Promise<AxiosResponse<number[], any>>);
    encode: ((subject, data, version?) => Promise<Buffer>);
    getSchemaBySubjectsAndVersion: ((data) => Promise<AxiosResponse<unknown, any>>);
    getSchemasById: ((id) => Promise<AxiosResponse<{
        schema: string;
    }, any>>);
    getSchemasTypes: (() => Promise<AxiosResponse<string[], any>>);
    getSchemasVersionsById: ((id) => Promise<AxiosResponse<{
        subject: string;
        version: number;
    }[], any>>);
    getSubjects: (() => Promise<AxiosResponse<string[], any>>);
    getSubjectsByVersion: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        schemaType: string;
        subject: string;
        version: number;
    }, any>>);
    getSubjectsVersions: ((subject) => Promise<AxiosResponse<number[], any>>);
    ping: (() => Promise<AxiosResponse<Record<string, unknown>, any>>);
    postSubjects: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        subject: string;
        version: number;
    }, any>>);
    postSubjectsVersions: ((data) => Promise<AxiosResponse<{
        id: number;
    }, any>>);
}>

Description
Method for creating new connection
Inherited from Connector.create
- Defined in packages/@biorate/connector/src/index.ts:97

get

get(name?): {
    decode: ((buffer) => Promise<any>);
    deleteSubjects: ((data) => Promise<AxiosResponse<number[], any>>);
    encode: ((subject, data, version?) => Promise<Buffer>);
    getSchemaBySubjectsAndVersion: ((data) => Promise<AxiosResponse<unknown, any>>);
    getSchemasById: ((id) => Promise<AxiosResponse<{
        schema: string;
    }, any>>);
    getSchemasTypes: (() => Promise<AxiosResponse<string[], any>>);
    getSchemasVersionsById: ((id) => Promise<AxiosResponse<{
        subject: string;
        version: number;
    }[], any>>);
    getSubjects: (() => Promise<AxiosResponse<string[], any>>);
    getSubjectsByVersion: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        schemaType: string;
        subject: string;
        version: number;
    }, any>>);
    getSubjectsVersions: ((subject) => Promise<AxiosResponse<number[], any>>);
    ping: (() => Promise<AxiosResponse<Record<string, unknown>, any>>);
    postSubjects: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        subject: string;
        version: number;
    }, any>>);
    postSubjectsVersions: ((data) => Promise<AxiosResponse<{
        id: number;
    }, any>>);
}
Parameters
- Optional name: string
  Optional
Returns {
    decode: ((buffer) => Promise<any>);
    deleteSubjects: ((data) => Promise<AxiosResponse<number[], any>>);
    encode: ((subject, data, version?) => Promise<Buffer>);
    getSchemaBySubjectsAndVersion: ((data) => Promise<AxiosResponse<unknown, any>>);
    getSchemasById: ((id) => Promise<AxiosResponse<{
        schema: string;
    }, any>>);
    getSchemasTypes: (() => Promise<AxiosResponse<string[], any>>);
    getSchemasVersionsById: ((id) => Promise<AxiosResponse<{
        subject: string;
        version: number;
    }[], any>>);
    getSubjects: (() => Promise<AxiosResponse<string[], any>>);
    getSubjectsByVersion: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        schemaType: string;
        subject: string;
        version: number;
    }, any>>);
    getSubjectsVersions: ((subject) => Promise<AxiosResponse<number[], any>>);
    ping: (() => Promise<AxiosResponse<Record<string, unknown>, any>>);
    postSubjects: ((data) => Promise<AxiosResponse<{
        id: number;
        schema: string;
        subject: string;
        version: number;
    }, any>>);
    postSubjectsVersions: ((data) => Promise<AxiosResponse<{
        id: number;
    }, any>>);
}
- decode: ((buffer) => Promise<any>)
  - - (buffer): Promise<any>
    - Parameters
      
      buffer: Buffer
      Returns Promise<any>
- deleteSubjects: ((data) => Promise<AxiosResponse<number[], any>>)
  - - (data): Promise<AxiosResponse<number[], any>>
    - Parameters
      
      data: {
      permanent?: boolean;
      subject: string;
      }
      
      Optional permanent?: boolean
      
      subject: string
      Returns Promise<AxiosResponse<number[], any>>
- encode: ((subject, data, version?) => Promise<Buffer>)
  - - (subject, data, version?): Promise<Buffer>
    - Parameters
      
      subject: string
      
      data: Record<string, any>
      
      version: string | number = 'latest'
      Returns Promise<Buffer>
- getSchemaBySubjectsAndVersion: ((data) => Promise<AxiosResponse<unknown, any>>)
  - - (data): Promise<AxiosResponse<unknown, any>>
    - Parameters
      
      data: {
      subject: string;
      version: string | number;
      }
      
      subject: string
      
      version: string | number
      Returns Promise<AxiosResponse<unknown, any>>
- getSchemasById: ((id) => Promise<AxiosResponse<{
  schema: string;
  }, any>>)
  - - (id): Promise<AxiosResponse<{
      schema: string;
      }, any>>
    - Parameters
      
      id: number
      Returns Promise<AxiosResponse<{
      schema: string;
      }, any>>
- getSchemasTypes: (() => Promise<AxiosResponse<string[], any>>)
  - - (): Promise<AxiosResponse<string[], any>>
    - Returns Promise<AxiosResponse<string[], any>>
- getSchemasVersionsById: ((id) => Promise<AxiosResponse<{
  subject: string;
  version: number;
  }[], any>>)
  - - (id): Promise<AxiosResponse<{
      subject: string;
      version: number;
      }[], any>>
    - Parameters
      
      id: number
      Returns Promise<AxiosResponse<{
      subject: string;
      version: number;
      }[], any>>
- getSubjects: (() => Promise<AxiosResponse<string[], any>>)
  - - (): Promise<AxiosResponse<string[], any>>
    - Returns Promise<AxiosResponse<string[], any>>
- getSubjectsByVersion: ((data) => Promise<AxiosResponse<{
      id: number;
      schema: string;
      schemaType: string;
      subject: string;
      version: number;
  }, any>>)
  - - (data): Promise<AxiosResponse<{
          id: number;
          schema: string;
          schemaType: string;
          subject: string;
          version: number;
      }, any>>
    - Parameters
      
      data: {
      subject: string;
      version: string | number;
      }
      
      subject: string
      
      version: string | number
      Returns Promise<AxiosResponse<{
          id: number;
          schema: string;
          schemaType: string;
          subject: string;
          version: number;
      }, any>>
- getSubjectsVersions: ((subject) => Promise<AxiosResponse<number[], any>>)
  - - (subject): Promise<AxiosResponse<number[], any>>
    - Parameters
      
      subject: string
      Returns Promise<AxiosResponse<number[], any>>
- ping: (() => Promise<AxiosResponse<Record<string, unknown>, any>>)
  - - (): Promise<AxiosResponse<Record<string, unknown>, any>>
    - Returns Promise<AxiosResponse<Record<string, unknown>, any>>
- postSubjects: ((data) => Promise<AxiosResponse<{
      id: number;
      schema: string;
      subject: string;
      version: number;
  }, any>>)
  - - (data): Promise<AxiosResponse<{
          id: number;
          schema: string;
          subject: string;
          version: number;
      }, any>>
    - Parameters
      
      data: {
          normalize?: boolean;
          reference?: string;
          schema: string | Record<string, any>;
          schemaType?: string;
          subject: string;
      }
      
      Optional normalize?: boolean
      
      Optional reference?: string
      
      schema: string | Record<string, any>
      
      Optional schemaType?: string
      
      subject: string
      Returns Promise<AxiosResponse<{
          id: number;
          schema: string;
          subject: string;
          version: number;
      }, any>>
- postSubjectsVersions: ((data) => Promise<AxiosResponse<{
  id: number;
  }, any>>)
  - - (data): Promise<AxiosResponse<{
      id: number;
      }, any>>
    - Parameters
      
      data: {
          normalize?: boolean;
          reference?: string;
          schema: string | Record<string, any>;
          schemaType?: string;
          subject: string;
      }
      
      Optional normalize?: boolean
      
      Optional reference?: string
      
      schema: string | Record<string, any>
      
      Optional schemaType?: string
      
      subject: string
      Returns Promise<AxiosResponse<{
      id: number;
      }, any>>
Description
Alias for connection method
Inherited from Connector.get
- Defined in packages/@biorate/connector/src/index.ts:124

`Protected` initialize

initialize(): Promise<void>
Returns Promise<void>

Description
Initialize method
Inherited from Connector.initialize
- Defined in packages/@biorate/connector/src/index.ts:130

use

use(name): void
Parameters
- name: string
Returns void

Description
Method for changing current connection
Inherited from Connector.use
- Defined in packages/@biorate/connector/src/index.ts:105

Class SchemaRegistryConnector

Description

Features:

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns SchemaRegistryConnector

Properties

Private #connections

Type declaration

decode: ((buffer) => Promise<any>)

Parameters

buffer: Buffer

Returns Promise<any>

deleteSubjects: ((data) => Promise<AxiosResponse<number[], any>>)

Parameters

data: { permanent?: boolean; subject: string; }

Optional permanent?: boolean

subject: string

Returns Promise<AxiosResponse<number[], any>>

encode: ((subject, data, version?) => Promise<Buffer>)

Parameters

subject: string

data: Record<string, any>

version: string | number = 'latest'

Returns Promise<Buffer>

getSchemaBySubjectsAndVersion: ((data) => Promise<AxiosResponse<unknown, any>>)

Parameters

data: { subject: string; version: string | number; }

subject: string

version: string | number

Returns Promise<AxiosResponse<unknown, any>>

getSchemasById: ((id) => Promise<AxiosResponse<{ schema: string; }, any>>)

Parameters

id: number

Returns Promise<AxiosResponse<{ schema: string; }, any>>

getSchemasTypes: (() => Promise<AxiosResponse<string[], any>>)

Returns Promise<AxiosResponse<string[], any>>

getSchemasVersionsById: ((id) => Promise<AxiosResponse<{ subject: string; version: number; }[], any>>)

Parameters

id: number

Returns Promise<AxiosResponse<{ subject: string; version: number; }[], any>>

getSubjects: (() => Promise<AxiosResponse<string[], any>>)

Returns Promise<AxiosResponse<string[], any>>

getSubjectsByVersion: ((data) => Promise<AxiosResponse<{ id: number; schema: string; schemaType: string; subject: string; version: number; }, any>>)

Parameters

data: { subject: string; version: string | number; }

subject: string

version: string | number

Returns Promise<AxiosResponse<{ id: number; schema: string; schemaType: string; subject: string; version: number; }, any>>

getSubjectsVersions: ((subject) => Promise<AxiosResponse<number[], any>>)

Parameters

subject: string

Returns Promise<AxiosResponse<number[], any>>

ping: (() => Promise<AxiosResponse<Record<string, unknown>, any>>)

Returns Promise<AxiosResponse<Record<string, unknown>, any>>

postSubjects: ((data) => Promise<AxiosResponse<{ id: number; schema: string; subject: string; version: number; }, any>>)

Parameters

data: { normalize?: boolean; reference?: string; schema: string | Record<string, any>; schemaType?: string; subject: string; }

Optional normalize?: boolean

Optional reference?: string

schema: string | Record<string, any>

Optional schemaType?: string

subject: string

Returns Promise<AxiosResponse<{ id: number; schema: string; subject: string; version: number; }, any>>

postSubjectsVersions: ((data) => Promise<AxiosResponse<{ id: number; }, any>>)

Parameters

data: { normalize?: boolean; reference?: string; schema: string | Record<string, any>; schemaType?: string; subject: string; }

Optional normalize?: boolean

Optional reference?: string

schema: string | Record<string, any>

Optional schemaType?: string

subject: string

Returns Promise<AxiosResponse<{ id: number; }, any>>

`Private` #connections

data: {
permanent?: boolean;
subject: string;
}

`Optional` permanent?: boolean

data: {
subject: string;
version: string | number;
}

getSchemasById: ((id) => Promise<AxiosResponse<{
schema: string;
}, any>>)

Returns Promise<AxiosResponse<{
schema: string;
}, any>>

getSchemasVersionsById: ((id) => Promise<AxiosResponse<{
subject: string;
version: number;
}[], any>>)

Returns Promise<AxiosResponse<{
subject: string;
version: number;
}[], any>>

getSubjectsByVersion: ((data) => Promise<AxiosResponse<{
id: number;
schema: string;
schemaType: string;
subject: string;
version: number;
}, any>>)

data: {
subject: string;
version: string | number;
}

Returns Promise<AxiosResponse<{
id: number;
schema: string;
schemaType: string;
subject: string;
version: number;
}, any>>

postSubjects: ((data) => Promise<AxiosResponse<{
id: number;
schema: string;
subject: string;
version: number;
}, any>>)

data: {
normalize?: boolean;
reference?: string;
schema: string | Record<string, any>;
schemaType?: string;
subject: string;
}

`Optional` normalize?: boolean

`Optional` reference?: string

`Optional` schemaType?: string

Returns Promise<AxiosResponse<{
id: number;
schema: string;
subject: string;
version: number;
}, any>>

postSubjectsVersions: ((data) => Promise<AxiosResponse<{
id: number;
}, any>>)

data: {
normalize?: boolean;
reference?: string;
schema: string | Record<string, any>;
schemaType?: string;
subject: string;
}

`Optional` normalize?: boolean

`Optional` reference?: string

`Optional` schemaType?: string

Returns Promise<AxiosResponse<{
id: number;
}, any>>

`Private` #connections

data: {
permanent?: boolean;
subject: string;
}

`Optional` permanent?: boolean

data: {
subject: string;
version: string | number;
}

getSchemasById: ((id) => Promise<AxiosResponse<{
schema: string;
}, any>>)

Returns Promise<AxiosResponse<{
schema: string;
}, any>>

getSchemasVersionsById: ((id) => Promise<AxiosResponse<{
subject: string;
version: number;
}[], any>>)

Returns Promise<AxiosResponse<{
subject: string;
version: number;
}[], any>>

getSubjectsByVersion: ((data) => Promise<AxiosResponse<{
id: number;
schema: string;
schemaType: string;
subject: string;
version: number;
}, any>>)

data: {
subject: string;
version: string | number;
}

Returns Promise<AxiosResponse<{
id: number;
schema: string;
schemaType: string;
subject: string;
version: number;
}, any>>

postSubjects: ((data) => Promise<AxiosResponse<{
id: number;
schema: string;
subject: string;
version: number;
}, any>>)

data: {
normalize?: boolean;
reference?: string;
schema: string | Record<string, any>;
schemaType?: string;
subject: string;
}

`Optional` normalize?: boolean

`Optional` reference?: string

`Optional` schemaType?: string

Returns Promise<AxiosResponse<{
id: number;
schema: string;
subject: string;
version: number;
}, any>>

postSubjectsVersions: ((data) => Promise<AxiosResponse<{
id: number;
}, any>>)

data: {
normalize?: boolean;
reference?: string;
schema: string | Record<string, any>;
schemaType?: string;
subject: string;
}

`Optional` normalize?: boolean

`Optional` reference?: string

`Optional` schemaType?: string

Returns Promise<AxiosResponse<{
id: number;
}, any>>

`Private` #current