Function create

  • create(config): {
        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, {}>>);
        putConfig: ((data) => Promise<AxiosResponse<{
            compatibility: ICompatibilities;
        }, any, {}>>);
    }

  • Parameters

    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, {}>>);
        putConfig: ((data) => Promise<AxiosResponse<{
            compatibility: ICompatibilities;
        }, 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, {}>>)
    • 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, {}>>)
    • 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, {}>>)
    • ping: (() => 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, {}>>

    • putConfig: ((data) => Promise<AxiosResponse<{
          compatibility: ICompatibilities;
      }, any, {}>>)

Settings

Member Visibility

Theme