TestAnnotationMap overview

Added in v1.0.0

Table of contents

• constructors
  • empty
  • make
• getters
  • get
• models
  • TestAnnotationMap (interface)
• mutations
  • annotate
  • combine
  • overwrite
  • update
• refinements
  • isTestAnnotationMap
• symbols
  • TestAnnotationMapTypeId
  • TestAnnotationMapTypeId (type alias)

constructors

empty

The empty TestAnnotationMap.

Signature

export declare const empty: TestAnnotationMap

Added in v1.0.0

make

Constructs a new TestAnnotationMap from the specified map.

Signature

export declare const make: (map: ReadonlyMap<TestAnnotation.TestAnnotation<unknown>, unknown>) => TestAnnotationMap

Added in v1.0.0

getters

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

Added in v1.0.0

models

TestAnnotationMap (interface)

An annotation map keeps track of annotations of different types.

Signature

export interface TestAnnotationMap extends TestAnnotationMap.Proto {}

Added in v1.0.0

mutations

annotate

Appends the specified annotation to the annotation map.

Signature

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

Added in v1.0.0

combine

Combines two TestAnnotationMaps.

Signature

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

Added in v1.0.0

overwrite

Overwrites the specified key/value pair in the TestAnnotationMap.

Signature

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

Added in v1.0.0

update

Updates the value associated with the specified key specified in the TestAnnotationMap.

Signature

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

Added in v1.0.0

refinements

isTestAnnotationMap

Returns true if the specified value is a TestAnnotationMap, false otherwise.

Signature

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

Added in v1.0.0

symbols

TestAnnotationMapTypeId

Signature

export declare const TestAnnotationMapTypeId: typeof TestAnnotationMapTypeId

Added in v1.0.0

TestAnnotationMapTypeId (type alias)

Signature

export type TestAnnotationMapTypeId = typeof TestAnnotationMapTypeId

Added in v1.0.0