• Preparing search index...
  • The search index is not available
@fishjam-dev/js-server-sdk
  • @fishjam-dev/js-server-sdk
  • index
  • HealthApiFactory

Function HealthApiFactory

  • HealthApiFactory(configuration?, basePath?, axios?): {
        healthcheck(options?): AxiosPromise<HealthcheckResponse>;
    }
  • HealthApi - factory interface

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        healthcheck(options?): AxiosPromise<HealthcheckResponse>;
    }

    • healthcheck:function
      • healthcheck(options?): AxiosPromise<HealthcheckResponse>
      • Parameters

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<HealthcheckResponse>

        Summary

        Describes the health of Fishjam

        Throws

        • Defined in openapi/api.ts:1124

    Export

    • Defined in openapi/api.ts:1115

Settings

Member Visibility

Theme

@fishjam-dev/js-server-sdk
  • Loading...

Generated using TypeDoc