Class CatalogsController

Hierarchy (View Summary)

BaseController
- CatalogsController

Index

Constructors

Properties

basePath config request

Methods

createCatalog deleteCatalog exportCatalog getCatalog init listCatalogs updateCatalog

Constructors

constructor

new CatalogsController(
config: HybridFormsClientConfig,
request: RequestType,
): CatalogsController
Parameters
- config: HybridFormsClientConfig
- request: RequestType
Returns CatalogsController
Inherited from BaseController.constructor
- Defined in controller/BaseController.ts:5

Properties

`Protected`basePath

basePath: string = ''

`Protected` `Readonly`config

config: HybridFormsClientConfig

`Protected` `Readonly`request

request: RequestType

Methods

createCatalog

createCatalog(
catalogName: string,
data: string | object,
): Promise<FetchResponse<string[]>>
Parameters
- catalogName: string
- data: string | object
Returns Promise<FetchResponse<string[]>>
- Defined in controller/CatalogsController.ts:76

deleteCatalog

deleteCatalog(
catalogName: string,
): Promise<FetchResponse<DeleteCatalogResponse>>
Parameters
- catalogName: string
Returns Promise<FetchResponse<DeleteCatalogResponse>>
- Defined in controller/CatalogsController.ts:65

exportCatalog

exportCatalog<T extends keyof ExportCatalogMapping = never>(
    catalogName: string,
    params?: ExportCatalogParams<T>,
): Promise<
    FetchResponse<
        ExportCatalogMapping[T] extends null ? string : ExportCatalogMapping[T],
    >,
>
Type Parameters
- T extends keyof ExportCatalogMapping = never
Parameters
- catalogName: string
- params: ExportCatalogParams<T> = {}
Returns Promise<
    FetchResponse<
        ExportCatalogMapping[T] extends null ? string : ExportCatalogMapping[T],
    >,
>
- Defined in controller/CatalogsController.ts:43

getCatalog

getCatalog(
catalogName: string,
params?: GetCatalogParams,
): Promise<FetchResponse<GetCatalogResponse>>
Parameters
- catalogName: string
- params: GetCatalogParams = {}
Returns Promise<FetchResponse<GetCatalogResponse>>
- Defined in controller/CatalogsController.ts:27

`Protected`init

init(): void
Returns void
Overrides BaseController.init
- Defined in controller/CatalogsController.ts:14

listCatalogs

listCatalogs(): Promise<FetchResponse<CatalogListResponse[]>>
Returns Promise<FetchResponse<CatalogListResponse[]>>
- Defined in controller/CatalogsController.ts:18

updateCatalog

updateCatalog(
catalogName: string,
data: string | object,
): Promise<FetchResponse<string[]>>
Parameters
- catalogName: string
- data: string | object
Returns Promise<FetchResponse<string[]>>
- Defined in controller/CatalogsController.ts:97