effect-state-machine
ReferenceGenerated API

SourceLocation API

Generated reference for the public SourceLocation module.

effect-state-machine API


effect-state-machine API / SourceLocation

SourceLocation

converting

EditorResolver

EditorResolver = (location) => string | undefined

Defined in: packages/core/src/SourceLocation.ts:35

Converts a source location to an editor navigation link.

Parameters

location

Location

Returns

string | undefined

Since

0.1.0


resolve()

resolve(reference, options?): Location | undefined

Defined in: packages/core/src/SourceLocation.ts:125

Resolves the first trustworthy authored location from a captured source reference.

Details

Internal library frames are skipped before and after optional mapping. Resolution is best-effort and returns undefined when no usable frame remains.

Parameters

reference

Reference | undefined

options?

Readonly<{ map?: ... | ...; }>

Returns

Location | undefined

Since

0.1.0


vscode

const vscode: EditorResolver

Defined in: packages/core/src/SourceLocation.ts:152

Resolves a source location to a VS Code vscode://file link.

Since

0.1.0


cursor

const cursor: EditorResolver

Defined in: packages/core/src/SourceLocation.ts:160

Resolves a source location to a Cursor cursor://file link.

Since

0.1.0

decoding

parseFrame()

parseFrame(frame): Location | undefined

Defined in: packages/core/src/SourceLocation.ts:96

Parses a Node- or browser-style stack frame into a validated source location.

Details

Node internals, anonymous frames, HTML document frames, and non-positive positions are rejected. File URLs are decoded to filesystem paths.

Parameters

frame

string

Returns

Location | undefined

Since

0.1.0

models

Location

Defined in: packages/core/src/SourceLocation.ts:10

One-based source position suitable for display or editor navigation.

Since

0.1.0

Properties

file

readonly file: string

Defined in: packages/core/src/SourceLocation.ts:11

line

readonly line: number

Defined in: packages/core/src/SourceLocation.ts:12

column

readonly column: number

Defined in: packages/core/src/SourceLocation.ts:13

functionName?

readonly optional functionName?: string

Defined in: packages/core/src/SourceLocation.ts:14

transforming

Mapper

Mapper = (generated) => Location | undefined

Defined in: packages/core/src/SourceLocation.ts:27

Maps a generated position to its authored source position.

Details

Returning undefined marks the generated position as untrustworthy and omits it from tooling.

Parameters

generated

Location

Returns

Location | undefined

Since

0.1.0