Skip to main content
Version: 15.0

Class: SpectacularPipeHarness<TValue>

A harness for testing an Angular pipe.

Includes an API to write a value and read the rendered text.

Type parameters​

Name
TValue

Constructors​

constructor​

• new SpectacularPipeHarness<TValue>()

Type parameters​

Name
TValue

Accessors​

template​

• Abstract set template(template): void

Replace the pipe component template.

NOTE! The value property is in context of the specified template.

Parameters​

NameTypeDescription
templatestringThe component template used to test the Angular pipe, for example '{{ value | camelize }}'.

Returns​

void

Defined in​

packages/spectacular/src/lib/pipe-testing/pipe-harness/spectacular-pipe-harness.ts:18


text​

• Abstract get text(): string

Read the text rendered in the pipe component template.

Returns​

string

Defined in​

packages/spectacular/src/lib/pipe-testing/pipe-harness/spectacular-pipe-harness.ts:22


value​

• Abstract set value(value): void

Update the value passed through the Angular pipe.

Parameters​

NameTypeDescription
valuenull | TValue | Observable<TValue>The new value.

Returns​

void

Defined in​

packages/spectacular/src/lib/pipe-testing/pipe-harness/spectacular-pipe-harness.ts:28

Methods​

inject​

▸ Abstract inject<T>(token, notFoundValue, options): T

Resolve a dependency based on the specified dependency injection token.

Throws

When the notFoundValue is undefined or Injector.THROW_IF_NOT_FOUND

Type parameters​

Name
T

Parameters​

NameTypeDescription
tokenProviderToken<T>The token representing the dependency, that is a class or an InjectionToken.
notFoundValueundefinedThe default value in case the specified dependency has not been provided. Optional. Default is null.
optionsInjectOptions & { optional?: false }Dependency injection options. Optional.

Returns​

T

The instance from the injector if defined, otherwise the notFoundValue.

Defined in​

packages/spectacular/src/lib/pipe-testing/pipe-harness/spectacular-pipe-harness.ts:40

▸ Abstract inject<T>(token, notFoundValue, options): null | T

Type parameters​

Name
T

Parameters​

NameType
tokenProviderToken<T>
notFoundValueundefined | null
optionsInjectOptions

Returns​

null | T

Defined in​

packages/spectacular/src/lib/pipe-testing/pipe-harness/spectacular-pipe-harness.ts:47

▸ Abstract inject<T>(token, notFoundValue?, options?): T

Type parameters​

Name
T

Parameters​

NameType
tokenProviderToken<T>
notFoundValue?T
options?InjectOptions

Returns​

T

Defined in​

packages/spectacular/src/lib/pipe-testing/pipe-harness/spectacular-pipe-harness.ts:52

▸ Abstract inject<T>(token, notFoundValue?, flags?): T

Resolve a dependency based on the specified dependency injection token.

Throws

When the notFoundValue is undefined or Injector.THROW_IF_NOT_FOUND

Deprecated

Use object-based flags (InjectOptions) instead.

Type parameters​

Name
T

Parameters​

NameTypeDescription
tokenProviderToken<T>The token representing the dependency, that is a class or an InjectionToken.
notFoundValue?TThe default value in case the specified dependency has not been provided. Optional. Default is null.
flags?InjectFlagsDependency injection options, for example InjectFlags.Optional | InjectFlags.SkipSelf. Optional. Default is InjectFlags.Default.

Returns​

T

The instance from the injector if defined, otherwise the notFoundValue.

Defined in​

packages/spectacular/src/lib/pipe-testing/pipe-harness/spectacular-pipe-harness.ts:71

▸ Abstract inject<T>(token, notFoundValue, flags?): null | T

Resolve a dependency based on the specified dependency injection token.

Throws

When the notFoundValue is undefined or Injector.THROW_IF_NOT_FOUND

Deprecated

Use object-based flags (InjectOptions) instead.

Type parameters​

Name
T

Parameters​

NameTypeDescription
tokenProviderToken<T>The token representing the dependency, that is a class or an InjectionToken.
notFoundValuenullThe default value in case the specified dependency has not been provided. Optional. Default is null.
flags?InjectFlagsDependency injection options, for example InjectFlags.Optional | InjectFlags.SkipSelf. Optional. Default is InjectFlags.Default.

Returns​

null | T

The instance from the injector if defined, otherwise the notFoundValue.

Defined in​

packages/spectacular/src/lib/pipe-testing/pipe-harness/spectacular-pipe-harness.ts:90