Variable ServiceFactoryConst

Type declaration

• build: ((params) => {
      getAll: (<Response>(params) => Promise<undefined | KosServiceResponse<Response[]>>);
      getModelById: (<Response>(params) => Promise<undefined | KosServiceResponse<Response>>);
      getOne: (<Response>(params) => Promise<undefined | KosServiceResponse<Response>>);
      addModel: (<Request>(params) => Promise<undefined | KosServiceResponse<any>>);
      deleteModel: (<ResponseType>(params) => Promise<undefined | KosServiceResponse<ResponseType>>);
      modifyModel: (<Request>(params) => Promise<undefined | KosServiceResponse<any>>);
      putModel: (<Request>(params) => Promise<undefined | KosServiceResponse<any>>);
      postModel: (<Request>(params) => Promise<undefined | KosServiceResponse<any>>);
  })

  Builds a service instance with the specified configuration.

  Returns

  An object with service methods for interacting with the server.

  Example

  // Create a Kos service instance for managing entities.
  const entityService = ServiceFactory.build({
    basePath: "/api/entities",
    getAllPath: "/list",
    getOnePath: "/get",
    deleteModelPath: "/delete",
    addModelPath: "/add",
    modifyModelPath: "/modify",
  });
  
  // Fetch a list of entities.
  const entities = await entityService.getAll({ ordered: true });
  
  // Get details of a specific entity by ID.
  const entityDetails = await entityService.getModelById({ id: "entity123" });
  
  // Add a new entity to the server.
  const newEntity = { name: "New Entity" };
  await entityService.addModel({ model: newEntity });
  
  // Modify an existing entity.
  const updatedEntity = { id: "entity123", name: "Updated Entity" };
  await entityService.modifyModel({ model: updatedEntity });
  Copy

  • • (params): {
          getAll: (<Response>(params) => Promise<undefined | KosServiceResponse<Response[]>>);
          getModelById: (<Response>(params) => Promise<undefined | KosServiceResponse<Response>>);
          getOne: (<Response>(params) => Promise<undefined | KosServiceResponse<Response>>);
          addModel: (<Request>(params) => Promise<undefined | KosServiceResponse<any>>);
          deleteModel: (<ResponseType>(params) => Promise<undefined | KosServiceResponse<ResponseType>>);
          modifyModel: (<Request>(params) => Promise<undefined | KosServiceResponse<any>>);
          putModel: (<Request>(params) => Promise<undefined | KosServiceResponse<any>>);
          postModel: (<Request>(params) => Promise<undefined | KosServiceResponse<any>>);
      }

    • Parameters

      • params: ServiceFactoryParams

        The configuration parameters for the service instance.

      Returns {
          getAll: (<Response>(params) => Promise<undefined | KosServiceResponse<Response[]>>);
          getModelById: (<Response>(params) => Promise<undefined | KosServiceResponse<Response>>);
          getOne: (<Response>(params) => Promise<undefined | KosServiceResponse<Response>>);
          addModel: (<Request>(params) => Promise<undefined | KosServiceResponse<any>>);
          deleteModel: (<ResponseType>(params) => Promise<undefined | KosServiceResponse<ResponseType>>);
          modifyModel: (<Request>(params) => Promise<undefined | KosServiceResponse<any>>);
          putModel: (<Request>(params) => Promise<undefined | KosServiceResponse<any>>);
          postModel: (<Request>(params) => Promise<undefined | KosServiceResponse<any>>);
      }

      • getAll: (<Response>(params) => Promise<undefined | KosServiceResponse<Response[]>>)

        Retrieves a list of entities managed by the KOS Server.

        Returns

        The list of entities.

        • • <Response>(params): Promise<undefined | KosServiceResponse<Response[]>>

          • Type Parameters

            • Response

            Parameters

            • params: GetAllParams

              The parameters for the request, including common options.

            Returns Promise<undefined | KosServiceResponse<Response[]>>

      • getModelById: (<Response>(params) => Promise<undefined | KosServiceResponse<Response>>)

        Retrieves details of a specific entity by its ID.

        Returns

        Details of the requested entity.

        • • <Response>(params): Promise<undefined | KosServiceResponse<Response>>

          • Type Parameters

            • Response

            Parameters

            • params: GetModelByIdParams

              The parameters for the request, including common options and the entity ID.

            Returns Promise<undefined | KosServiceResponse<Response>>

      • getOne: (<Response>(params) => Promise<undefined | KosServiceResponse<Response>>)

        Retrieves details of a single entity.

        Returns

        Details of the requested entity.

        • • <Response>(params): Promise<undefined | KosServiceResponse<Response>>

          • Type Parameters

            • Response

            Parameters

            • params: GetAllParams

              The parameters for the request, including common options.

            Returns Promise<undefined | KosServiceResponse<Response>>

      • addModel: (<Request>(params) => Promise<undefined | KosServiceResponse<any>>)

        Adds a new entity to the server.

        Returns

        An empty response with status 200.

        • • <Request>(params): Promise<undefined | KosServiceResponse<any>>

          • Type Parameters

            • Request

            Parameters

            • params: AddModelParams<Request>

              The parameters for the request, including common options and the new entity model.

            Returns Promise<undefined | KosServiceResponse<any>>

      • deleteModel: (<ResponseType>(params) => Promise<undefined | KosServiceResponse<ResponseType>>)

        Deletes an entity from the server based on its ID.

        Returns

        An empty response with status 200.

        • • <ResponseType>(params): Promise<undefined | KosServiceResponse<ResponseType>>

          • Type Parameters

            • ResponseType = unknown

            Parameters

            • params: DeleteModelParams

              The parameters for the request, including common options and the entity ID.

            Returns Promise<undefined | KosServiceResponse<ResponseType>>

      • modifyModel: (<Request>(params) => Promise<undefined | KosServiceResponse<any>>)

        Modifies an existing entity on the server.

        Returns

        An empty response with status 200.

        • • <Request>(params): Promise<undefined | KosServiceResponse<any>>

          • Type Parameters

            • Request

            Parameters

            • params: ModifyModelParams<Request>

              The parameters for the request, including common options and the entity model.

            Returns Promise<undefined | KosServiceResponse<any>>

      • putModel: (<Request>(params) => Promise<undefined | KosServiceResponse<any>>)

        Modifies an existing entity on the server using the HTTP PUT method.

        Returns

        An empty response with status 200.

        • • <Request>(params): Promise<undefined | KosServiceResponse<any>>

          • Type Parameters

            • Request

            Parameters

            • params: ModifyModelParams<Request>

              The parameters for the request, including common options and the entity model.

            Returns Promise<undefined | KosServiceResponse<any>>

      • postModel: (<Request>(params) => Promise<undefined | KosServiceResponse<any>>)

        Adds a new entity to the server using the HTTP POST method.

        Returns

        An empty response with status 200.

        • • <Request>(params): Promise<undefined | KosServiceResponse<any>>

          • Type Parameters

            • Request

            Parameters

            • params: AddModelParams<Request>

              The parameters for the request, including common options and the new entity model.

            Returns Promise<undefined | KosServiceResponse<any>>