Class SingletonApiClass<Prefix, CRUDApi, PathParams>

constructor

• new SingletonApiClass<Prefix, CRUDApi, PathParams>(prefix, crud?): SingletonApiClass<Prefix, CRUDApi, PathParams>

• Type Parameters

  • Prefix extends string

  • CRUDApi extends SingletonApiDefinitionMap

  • PathParams extends string = PathParamNames<Prefix>

  Parameters

  • prefix: Prefix

  • Optional crud: CRUDApi

  Returns SingletonApiClass<Prefix, CRUDApi, PathParams>

Readonly crud

Readonly datetimeMap

Readonly hasFileMap

Readonly pathParams

Readonly prefix

delete

• delete<Option>(...__namedParameters): Promise<GetSchema<CRUDApi, "delete", "response", never>>

• Type Parameters

  • Option extends DevfiveBaseQuerystring<TypeOf<GetSchema<CRUDApi, "delete", "response", never>>>

  Parameters

  • Rest ...__namedParameters: Optional<{
        headers?: Record<string, string | number>;
        qs?: Option;
    } & DevfiveApiRequestPathParamsOption<PathParams>, [PathParams] extends [never]
        ? true
        : false>

  Returns Promise<GetSchema<CRUDApi, "delete", "response", never>>

get

• get<Option, Ret>(...__namedParameters): Promise<Ret>

• Type Parameters

  • Option extends DevfiveBaseQuerystring<GetSchemaType<CRUDApi, "get", "response", false, never>>

  • Ret

  Parameters

  • Rest ...__namedParameters: Optional<{
        headers?: Record<string, string | number>;
        qs?: Option;
    } & DevfiveApiRequestPathParamsOption<PathParams>, [PathParams] extends [never]
        ? true
        : false>

  Returns Promise<Ret>

getSchema

• getSchema<Q, T>(model, key): GetSchema<CRUDApi, Q, T, never> & ZodObject<any, UnknownKeysParam, ZodTypeAny, {}, {}>

• Type Parameters

  • Q extends "delete" | "update" | "patch" | "get"

  • T extends "body" | "response"

  Parameters

  • model: Q

  • key: T

  Returns GetSchema<CRUDApi, Q, T, never> & ZodObject<any, UnknownKeysParam, ZodTypeAny, {}, {}>

getSchemaDescription

• getSchemaDescription<Q, T>(type, key, modelKey): string

• Type Parameters

  • Q extends "delete" | "update" | "patch" | "get"

  • T extends "body" | "response"

  Parameters

  • type: Q

  • key: T

  • modelKey: string | DeepKey<T>

  Returns string

patch

• patch<Option>(data?, option?): Promise<DevfiveBaseQueryToObject<GetSchemaType<CRUDApi, "patch", "response", true, never>, Option>>

• Type Parameters

  • Option extends DevfiveBaseQuerystring<GetSchemaType<CRUDApi, "patch", "response", false, never>>

  Parameters

  • Optional data: GetSchemaTypeWith$PathParams<PathParams, CRUDApi, "patch", "body", true, never>

  • Optional option: {
        headers?: Record<string, string | number>;
        qs?: Option;
    }

    • Optional headers?: Record<string, string | number>

    • Optional qs?: Option

  Returns Promise<DevfiveBaseQueryToObject<GetSchemaType<CRUDApi, "patch", "response", true, never>, Option>>

update

• update<Option, Ret>(data, option?): Promise<Ret>

• Type Parameters

  • Option extends DevfiveBaseQuerystring<GetSchemaType<CRUDApi, "update", "response", false, never>>

  • Ret

  Parameters

  • data: GetSchemaTypeWith$PathParams<PathParams, CRUDApi, "update", "body", false, never>

  • Optional option: {
        headers?: Record<string, string | number>;
        qs?: Option;
    }

    • Optional headers?: Record<string, string | number>

    • Optional qs?: Option

  Returns Promise<Ret>

useDeleteMutation

• useDeleteMutation<Option>(option?): UseMutationResult<GetSchema<CRUDApi, "delete", "response", never>, ErrorResponse<string>, {
      headers?: Record<string, string | number>;
      qs?: any;
  } & DevfiveApiRequestPathParamsOption<PathParams>>

• Type Parameters

  • Option extends DevfiveBaseQuerystring<TypeOf<GetSchema<CRUDApi, "delete", "response", never>>>

  Parameters

  • Optional option: {
        headers?: Record<string, string | number>;
        qs?: Option;
    } & Omit<UseMutationOptions<GetSchema<CRUDApi, "delete", "response", never>, ErrorResponse<string>, {
        headers?: Record<string, string | number>;
        qs?: any;
    } & DevfiveApiRequestPathParamsOption<PathParams>, unknown>, "mutationFn"> & MutateNotification

  Returns UseMutationResult<GetSchema<CRUDApi, "delete", "response", never>, ErrorResponse<string>, {
      headers?: Record<string, string | number>;
      qs?: any;
  } & DevfiveApiRequestPathParamsOption<PathParams>>

useGetApiQuery

• useGetApiQuery<Option, Ret>(...__namedParameters): UseQueryResult<Ret, ResultResponse<string>>

• Type Parameters

  • Option extends DevfiveBaseQuerystring<GetSchemaType<CRUDApi, "get", "response", false, never>>

  • Ret

  Parameters

  • Rest ...__namedParameters: Optional<{
        headers?: Record<string, string | number>;
        qs?: Option;
    } & DevfiveApiRequestPathParamsOption<PathParams> & Omit<UseQueryOptions<Ret, ResultResponse<string>, Ret, QueryKey>, "queryKey" | "queryFn"> & Pick<MutateNotification, "errorNotification" | "errorTo">, [PathParams] extends [never]
        ? true
        : false>

  Returns UseQueryResult<Ret, ResultResponse<string>>

usePatchMutation

• usePatchMutation<Option>(option?): UseMutationResult<DevfiveBaseQueryToObject<GetSchemaType<CRUDApi, "patch", "response", true, never>, Option>, ErrorResponse<string>, GetSchemaTypeWith$PathParams<PathParams, CRUDApi, "patch", "body", true, never>>

• Type Parameters

  • Option extends DevfiveBaseQuerystring<GetSchemaType<CRUDApi, "patch", "response", false, never>>

  Parameters

  • Optional option: {
        headers?: Record<string, string | number>;
        qs?: Option;
    } & Omit<UseMutationOptions<DevfiveBaseQueryToObject<GetSchemaType<CRUDApi, "patch", "response", true, never>, Option>, ErrorResponse<string>, GetSchemaTypeWith$PathParams<PathParams, CRUDApi, "patch", "body", true, never>, unknown>, "mutationFn"> & MutateNotification

  Returns UseMutationResult<DevfiveBaseQueryToObject<GetSchemaType<CRUDApi, "patch", "response", true, never>, Option>, ErrorResponse<string>, GetSchemaTypeWith$PathParams<PathParams, CRUDApi, "patch", "body", true, never>>

useUpdateMutation

• useUpdateMutation<Option>(option?): UseMutationResult<DevfiveBaseQueryToObject<GetSchemaType<CRUDApi, "update", "response", true, never>, Option>, ErrorResponse<string>, GetSchemaTypeWith$PathParams<PathParams, CRUDApi, "update", "body", false, never>>

• Type Parameters

  • Option extends DevfiveBaseQuerystring<GetSchemaType<CRUDApi, "update", "response", false, never>>

  Parameters

  • Optional option: {
        headers?: Record<string, string | number>;
        qs?: Option;
    } & Omit<UseMutationOptions<DevfiveBaseQueryToObject<GetSchemaType<CRUDApi, "update", "response", true, never>, Option>, ErrorResponse<string>, GetSchemaTypeWith$PathParams<PathParams, CRUDApi, "update", "body", false, never>, unknown>, "mutationFn"> & MutateNotification

  Returns UseMutationResult<DevfiveBaseQueryToObject<GetSchemaType<CRUDApi, "update", "response", true, never>, Option>, ErrorResponse<string>, GetSchemaTypeWith$PathParams<PathParams, CRUDApi, "update", "body", false, never>>