Skip to main content

Imports

A shared package that contains queries and types for imports settings.

Usage​

The module has been imported into our root npm package. All you have to do is import it into your module.

import {
  EnabledImportTypes,
  useEnabledImportTypesQuery,
  getEnabledImportTypes,
  invalidateImportsSettings,
} from '@shared/imports'

Exported Queries​

useEnabledImportTypesQuery​

Fetches an Import enabled settings from the private-api enabled_import_types endpoint.

const { data, isLoading } = useEnabledImportTypesQuery()

getEnabledImportTypes​

Fetches an Import enabled settings from the private-api enabled_import_types endpoint.

This is only to be used outside of React. If you are in React please use the hook.

const { data } = await getEnabledImportTypes()

Utils​

invalidateImportsSettings​

Invalidates an Import enabled settings query cache

invalidateImportsSettings()

Exported Types​

TypeDescription
EnabledImportTypesEnabledImportTypes resource returned by our private api