Skip to main content Link Search Menu Expand Document (external link)
effect

TestAnnotationMap.ts overview

Since v2.0.0

Exports Grouped by Category

utils

TestAnnotationMap (interface)

An annotation map keeps track of annotations of different types.

Signature

export interface TestAnnotationMap {
  readonly [TestAnnotationMapTypeId]: TestAnnotationMapTypeId
  /** @internal */
  readonly map: HashMap.HashMap<TestAnnotation.TestAnnotation<any>, any>
}

Source

Since v2.0.0

TestAnnotationMapTypeId

Signature

declare const TestAnnotationMapTypeId: unique symbol

Source

Since v2.0.0

TestAnnotationMapTypeId (type alias)

Signature

type TestAnnotationMapTypeId = typeof TestAnnotationMapTypeId

Source

Since v2.0.0

annotate

Appends the specified annotation to the annotation map.

Signature

declare const annotate: (<A>(
  key: TestAnnotation.TestAnnotation<A>,
  value: A
) => (self: TestAnnotationMap) => TestAnnotationMap) &
  (<A>(self: TestAnnotationMap, key: TestAnnotation.TestAnnotation<A>, value: A) => TestAnnotationMap)

Source

Since v2.0.0

combine

Signature

declare const combine: ((that: TestAnnotationMap) => (self: TestAnnotationMap) => TestAnnotationMap) &
  ((self: TestAnnotationMap, that: TestAnnotationMap) => TestAnnotationMap)

Source

Since v2.0.0

empty

Signature

declare const empty: (_: void) => TestAnnotationMap

Source

Since v2.0.0

get

Retrieves the annotation of the specified type, or its default value if there is none.

Signature

declare const get: (<A>(key: TestAnnotation.TestAnnotation<A>) => (self: TestAnnotationMap) => A) &
  (<A>(self: TestAnnotationMap, key: TestAnnotation.TestAnnotation<A>) => A)

Source

Since v2.0.0

isTestAnnotationMap

Signature

declare const isTestAnnotationMap: (u: unknown) => u is TestAnnotationMap

Source

Since v2.0.0

make

Signature

declare const make: (map: HashMap.HashMap<TestAnnotation.TestAnnotation<any>, any>) => TestAnnotationMap

Source

Since v2.0.0

overwrite

Signature

declare const overwrite: (<A>(
  key: TestAnnotation.TestAnnotation<A>,
  value: A
) => (self: TestAnnotationMap) => TestAnnotationMap) &
  (<A>(self: TestAnnotationMap, key: TestAnnotation.TestAnnotation<A>, value: A) => TestAnnotationMap)

Source

Since v2.0.0

update

Signature

declare const update: (<A>(
  key: TestAnnotation.TestAnnotation<A>,
  f: (value: A) => A
) => (self: TestAnnotationMap) => TestAnnotationMap) &
  (<A>(self: TestAnnotationMap, key: TestAnnotation.TestAnnotation<A>, f: (value: A) => A) => TestAnnotationMap)

Source

Since v2.0.0