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

TestAnnotationMap overview

Added in v2.0.0

Table of contents

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>
}

Added in v2.0.0

TestAnnotationMapTypeId

Signature

export declare const TestAnnotationMapTypeId: typeof TestAnnotationMapTypeId

Added in v2.0.0

TestAnnotationMapTypeId (type alias)

Signature

export type TestAnnotationMapTypeId = typeof TestAnnotationMapTypeId

Added in v2.0.0

annotate

Appends the specified annotation to the annotation map.

Signature

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

Added in v2.0.0

combine

Signature

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

Added in v2.0.0

empty

Signature

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

Added in v2.0.0

get

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

Signature

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

Added in v2.0.0

isTestAnnotationMap

Signature

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

Added in v2.0.0

make

Signature

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

Added in v2.0.0

overwrite

Signature

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

Added in v2.0.0

update

Signature

export 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)

Added in v2.0.0