Class DevfiveApiClass<PK, Prefix, CRUDApi, PathParams>

constructor

• new DevfiveApiClass<PK, Prefix, CRUDApi, PathParams>(pk, prefix, crud?): DevfiveApiClass<PK, Prefix, CRUDApi, PathParams>

• Type Parameters

  • PK extends string

  • Prefix extends string

  • CRUDApi extends DevfiveApiCRUDDefinitionMap

  • PathParams extends string = PathParamNames<Prefix, never>

  Parameters

  • pk: PK

  • prefix: Prefix

  • Optional crud: CRUDApi

  Returns DevfiveApiClass<PK, Prefix, CRUDApi, PathParams>

Readonly crud

Readonly datetimeMap

genAutoCompleteProps

Readonly hasFile

Readonly hasFileMap

Readonly pathParams

Readonly pk

Readonly prefix

create

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

• Type Parameters

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

  Parameters

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

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

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

    • Optional qs?: Option

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

delete

• delete(id, option?): Promise<[GetSchema<CRUDApi, "delete", "response", never>] extends [never]
      ? ResultResponse<boolean>
      : TypeOf<GetSchema<CRUDApi, "delete", "response", never>>>

• Parameters

  • id: GetItemByPK<PK, PathParams>

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

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

    • Optional qs?: any

  Returns Promise<[GetSchema<CRUDApi, "delete", "response", never>] extends [never]
      ? ResultResponse<boolean>
      : TypeOf<GetSchema<CRUDApi, "delete", "response", never>>>

downloadExcel

• downloadExcel(...__namedParameters): Promise<void>

• auto comlete props 를 생성합니다.

  Parameters

  • Rest ...__namedParameters: Optional<DevfiveApiRequestOptionWithPathParams<PathParams, DevfiveBaseQuerystring<GetSchemaType<CRUDApi, "getAll", "response", false, never>> & DevfiveGetAllQuerystring<GetSchemaType<CRUDApi, "getAll", "response", false, never>, DeepKeyOnApi<GetSchemaType<CRUDApi, "getAll", "response", false, never>, keyof GetSchemaType<CRUDApi, "getAll", "response", false, never>>>>, [PathParams] extends [never]
        ? true
        : false> & [{
        fileName?: string;
    }?]

  Returns Promise<void>

getAll

• getAll<Input, Option, Ret>(...__namedParameters): Promise<PaginationResponse<Ret>>

• 일반 request

  Type Parameters

  • Input extends never

  • Option extends DevfiveBaseQuerystring<Input> & DevfiveGetAllQuerystring<Input, DeepKeyOnApi<Input, keyof Input>>

  • Ret

  Parameters

  • Rest ...__namedParameters: Optional<DevfiveApiRequestOptionWithPathParams<PathParams, Option>, [PathParams] extends [never]
        ? true
        : false>

  Returns Promise<PaginationResponse<Ret>>

getOne

• getOne<Option, Ret>(id, option?): Promise<Ret>

• Type Parameters

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

  • Ret

  Parameters

  • id: GetItemByPK<PK, PathParams>

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

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

    • Optional qs?: Option

  Returns Promise<Ret>

getSchema

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

• Type Parameters

  • Q extends "delete" | "update" | "create" | "patch" | "getAll" | "getOne"

  • 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" | "create" | "patch" | "getAll" | "getOne"

  • 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<PK | 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>(data, option?): Promise<DevfiveBaseQueryToObject<GetSchemaType<CRUDApi, "update", "response", true, never>, Option>>

• Type Parameters

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

  Parameters

  • data: GetSchemaTypeWith$PathParams<PK | 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<DevfiveBaseQueryToObject<GetSchemaType<CRUDApi, "update", "response", true, never>, Option>>

useCreateMutation

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

• Type Parameters

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

  Parameters

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

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

useDeleteMutation

• useDeleteMutation<Option>(option?): UseMutationResult<[GetSchema<CRUDApi, "delete", "response", never>] extends [never]
      ? ResultResponse<boolean>
      : TypeOf<GetSchema<CRUDApi, "delete", "response", never>>, ErrorResponse<string>, GetItemByPK<PK, PathParams>>

• Type Parameters

  • Option extends DevfiveBaseQuerystring<[GetSchema<CRUDApi, "delete", "response", never>] extends [never]
        ? ResultResponse<boolean>
        : TypeOf<GetSchema<CRUDApi, "delete", "response", never>>>

  Parameters

  • Optional option: {
        headers?: Record<string, string | number>;
        qs?: Option;
    } & Omit<UseMutationOptions<[GetSchema<CRUDApi, "delete", "response", never>] extends [never]
        ? ResultResponse<boolean>
        : TypeOf<GetSchema<CRUDApi, "delete", "response", never>>, ErrorResponse<string>, GetItemByPK<PK, PathParams>, unknown>, "mutationFn"> & MutateNotification

  Returns UseMutationResult<[GetSchema<CRUDApi, "delete", "response", never>] extends [never]
      ? ResultResponse<boolean>
      : TypeOf<GetSchema<CRUDApi, "delete", "response", never>>, ErrorResponse<string>, GetItemByPK<PK, PathParams>>

useGetAllApiQuery

• useGetAllApiQuery<Key, Option, Response, Return>(...__namedParameters): UseQueryResult<PaginationResponse<Return>, ResultResponse<string>> & {
      genTableProps: GenTableProps<Return>;
      isLastPage: null | boolean;
      nextPage: (() => void);
      page: number;
      prevPage: (() => void);
      queryFormProps: {
          initialValues: Record<string, any>;
          onFinish: Dispatch<SetStateAction<Record<string, any>>>;
      };
      search: Record<string, any>;
      setPage: ((page) => void);
      setSearch: Dispatch<SetStateAction<Record<string, any>>>;
      setSize: ((size) => void);
      size: number;
  }

• Type Parameters

  • Key extends string

  • Option extends DevfiveBaseQuerystring<Response> & DevfiveGetAllQuerystring<Response, Key>

  • Response extends never

  • Return

  Parameters

  • Rest ...__namedParameters: OptionalFirstIfHasPathParams<PathParams, [option: {
        headers?: Record<string, string | number>;
        params?: Record<string, string | number>;
        qs?: Option;
    } & DevfiveApiRequestPathParamsOption<PathParams> & {
        defaultQs?: Option;
    } & Omit<UseQueryOptions<PaginationResponse<Return>, ResultResponse<string>, PaginationResponse<Return>, QueryKey>, "queryKey" | "queryFn">]>

  Returns UseQueryResult<PaginationResponse<Return>, ResultResponse<string>> & {
      genTableProps: GenTableProps<Return>;
      isLastPage: null | boolean;
      nextPage: (() => void);
      page: number;
      prevPage: (() => void);
      queryFormProps: {
          initialValues: Record<string, any>;
          onFinish: Dispatch<SetStateAction<Record<string, any>>>;
      };
      search: Record<string, any>;
      setPage: ((page) => void);
      setSearch: Dispatch<SetStateAction<Record<string, any>>>;
      setSize: ((size) => void);
      size: number;
  }

useGetOneApiQuery

• useGetOneApiQuery<Option, Ret>(id, option?): UseQueryResult<Ret, ResultResponse<string>> & {
      genDescriptionProps: GenDescriptionProps<Ret>;
  }

• Type Parameters

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

  • Ret

  Parameters

  • id: undefined | null | GetItemByPK<PK, PathParams>

  • Optional option: {
        headers?: Record<string, string | number>;
        qs?: Option;
    } & Omit<UseQueryOptions<Ret, ResultResponse<string>, Ret, QueryKey>, "queryKey" | "queryFn"> & Pick<MutateNotification, "errorNotification" | "errorTo">

  Returns UseQueryResult<Ret, ResultResponse<string>> & {
      genDescriptionProps: GenDescriptionProps<Ret>;
  }

usePatchMutation

• usePatchMutation<Option>(option?): UseMutationResult<DevfiveBaseQueryToObject<GetSchemaType<CRUDApi, "patch", "response", true, never>, Option>, ErrorResponse<string>, GetSchemaTypeWith$PathParams<PK | 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<PK | PathParams, CRUDApi, "patch", "body", true, never>, unknown>, "mutationFn"> & MutateNotification

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

useUpdateMutation

• useUpdateMutation<Option>(option?): UseMutationResult<DevfiveBaseQueryToObject<GetSchemaType<CRUDApi, "update", "response", true, never>, Option>, ErrorResponse<string>, GetSchemaTypeWith$PathParams<PK | 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<PK | PathParams, CRUDApi, "update", "body", false, never>, unknown>, "mutationFn"> & MutateNotification

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