Function default

Gets a project data provider with specified provider name

  • default<ProjectInterface extends keyof ProjectDataProviderInterfaces>(
        projectInterface: ProjectInterface,
        projectDataProviderSource:
            | undefined
            | string
            | ProjectDataProviderInterfaces[ProjectInterface],
        pdpFactoryId?: string,
    ): undefined | ProjectDataProviderInterfaces[ProjectInterface]

    Type Parameters

    Parameters

    • projectInterface: ProjectInterface

      projectInterface that the project to load must support. The TypeScript type for the returned project data provider will have the project data provider interface type associated with this projectInterface. If the project does not implement this projectInterface (according to its metadata), an error will be thrown.

    • projectDataProviderSource: undefined | string | ProjectDataProviderInterfaces[ProjectInterface]

      String name of the id of the project to get OR projectDataProvider (result of useProjectDataProvider, if you want this hook to just return the data provider again)

    • OptionalpdpFactoryId: string

      Optional ID of the PDP factory from which to get the project data provider if the PDP factory supports this project id and project interface. If not provided, then look in all available PDP factories for the given project ID.

    Returns undefined | ProjectDataProviderInterfaces[ProjectInterface]

    undefined if the Project Data Provider has not been retrieved, the requested Project Data Provider if it has been retrieved and is not disposed, and undefined again if the Project Data Provider is disposed

Settings

Member Visibility