Inspectable overview

A simple extension to the Effect Inspectable module

Table of contents

• Constants
  • BaseProto
• Models
  • IdSymbol
  • IdSymbol (type alias)
  • Type (interface)
• Module markers
  • moduleTag

Constants

BaseProto

Prototype of an Inspectable that overloads the toJSON and toString methods.

Signature

export declare const BaseProto: (moduleTag: string) => Inspectable.Inspectable

Models

IdSymbol

Symbol used to define a special prototype function that must return an id for the object

Signature

export declare const IdSymbol: typeof IdSymbol

IdSymbol (type alias)

Type used to define a special prototype function that must return an id for the object

Signature

export type IdSymbol = typeof IdSymbol

Type (interface)

Interface that an object should implement when an id can be used to represent it

Signature

export interface Type extends Inspectable.Inspectable {
  readonly [IdSymbol]: () => string
}

Module markers

moduleTag

Module tag

Signature

export declare const moduleTag: "@parischap/effect-lib/Inspectable/"