Interface IdentifierStrategy

Captures the behavior of container identifiers in a certain storage configuration.

interface IdentifierStrategy {
    contains: ((container: ResourceIdentifier, identifier: ResourceIdentifier, transitive: boolean) => boolean);
    getParentContainer: ((identifier: ResourceIdentifier) => ResourceIdentifier);
    isRootContainer: ((identifier: ResourceIdentifier) => boolean);
    supportsIdentifier: ((identifier: ResourceIdentifier) => boolean);
}

Implemented by

Properties

contains getParentContainer isRootContainer supportsIdentifier

Properties

contains

contains: ((container: ResourceIdentifier, identifier: ResourceIdentifier, transitive: boolean) => boolean)

Checks if the given container would contain the given identifier. This does not check that either of these identifiers actually exist. This is similar to calling getParentContainer on an identifier and comparing the result.

If transitive is false this only checks if container is the direct parent container of identifier.

getParentContainer

getParentContainer: ((identifier: ResourceIdentifier) => ResourceIdentifier)

Generates the identifier of the container this resource would be a member of. This does not check if that identifier actually exists. Will throw an error if the input identifier is a root container or is not supported.

isRootContainer

isRootContainer: ((identifier: ResourceIdentifier) => boolean)

Checks if the input corresponds to the identifier of a root container. This does not check if this identifier actually exists.

supportsIdentifier

supportsIdentifier: ((identifier: ResourceIdentifier) => boolean)

Verifies if this identifier is supported. This does not check if this identifier actually exists, but checks if the identifier is in scope for this class.

Settings

Member Visibility

On This Page

Properties