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

MarkMap overview

This module implements a map of the different marks that appear in a value to stringify.

With the make function, you can define your own instances if the provided ones don’t suit your needs.

Table of contents

Constructors

make

Constructor

Signature

export declare const make: (params: MTypes.Data<Type>) => Type

Destructors

id

Returns the id property of self

Signature

export declare const id: MTypes.OneArgFunction<Type, string>

marks

Returns the marks property of self

Signature

export declare const marks: MTypes.OneArgFunction<Type, Marks.Type>

Equivalences

equivalence

Equivalence

Signature

export declare const equivalence: Equivalence.Equivalence<Type>

Guards

has

Type guard

Signature

export declare const has: (u: unknown) => u is Type

Instances

utilInspectLike

Default MarkMap instance

Signature

export declare const utilInspectLike: Type

Models

Type (interface)

Interface that represents a MarkMap

Signature

export interface Type extends Equal.Equal, MInspectable.Inspectable, Pipeable.Pipeable {
  /** Id of this MarkMap instance. Useful for equality and debugging. */
  readonly id: string
  /** Map of the different marks that appear in a value to stringify */
  readonly marks: Marks.Type

  /** @internal */
  readonly [_TypeId]: _TypeId
}

moduleTag

Module tag

Signature

export declare const moduleTag: "@parischap/pretty-print/MarkMap/"