Interface GetOptions<T, K>

Options to get an EnvironmentState property.

Type Parameters

  • T extends NonUndefined<Property>

    The EnvironmentState property type.

  • K = T

    The expected property target type.

Hierarchy

Properties

config? defaultValue? required? targetType? transpile?

Properties

Optional config

config?: EnvironmentQueryConfig

Custom EnvironmentQuery config for this operation.

Optional defaultValue

defaultValue?: T

Value to resolve if the EnvironmentState property value is undefined.

Template

The EnvironmentState property type.

Optional required

required?: boolean

Throws EnvironmentReferenceError if required and the EnvironmentState property doesn't exist.

Optional targetType

targetType?: ((value?) => K)

Type declaration

    • (value?): K

    • Converts the EnvironmentState property value to the target type.

      Returns

      The converted value.

      Parameters

      • Optional value: T

        The value of the property at path.

      Returns K

Optional transpile

transpile?: EnvironmentState

Properties to resolve the EnvironmentState property value interpolation.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc