MarkdownSpeech.js

Overview

Re-exports the shared MarkdownSpeech class that removes repeated same formatting marks from streamed narration before speech segmentation.

• Artifact
  MarkdownSpeech.js · esm
• Classification
  public first party
• Availability
  Cross-host
• Normalization
  The runtime projection and public package subpath share speech-only filtering of repeated *, #, _, backtick, and ~ runs across chunks; single marks and all other characters remain literal; terminal flush and reset clear pending formatting state.

Import and lifecycle

import * as module from '/arcane/modules/MarkdownSpeech.js';

Import re-exports the shared MarkdownSpeech class from arcane-os/speech-text and performs no work. Each instance retains only a trailing candidate formatting mark between append() calls; terminal append and reset clear that instance state.

Application-facing behavior: MarkdownSpeech; append(text='',end=false), reset().

Exports, signatures, parameters, and results

Parameter meanings and results

new MarkdownSpeech(); append(text='',end=false) requires text to be a string and returns only newly available narration with repeated same *, #, _, backtick, and ~ runs removed. A trailing candidate formatting mark waits for the next chunk; a truthy end value flushes a pending single mark and resets state. reset() clears pending state and returns undefined. Single marks and every other character remain literal.

Events, side effects, and errors

Source-literal CustomEvent dispatches

No source-literal CustomEvent dispatch is part of this artifact.

Lifecycle and event flow

This artifact has no additional documented lifecycle event flow.

Direct coded failures

This artifact directly assigns no stable coded failure.

Exported Error subclasses

This artifact exports no Error subclass.

Documented failure behavior

• TypeError when append text is not a string.

Availability and capabilities

Cross-host. The runtime projection and public package subpath share speech-only filtering of repeated *, #, _, backtick, and ~ runs across chunks; single marks and all other characters remain literal; terminal flush and reset clear pending formatting state.

None. The runtime projection and public arcane-os/speech-text package subpath share the same implementation with strong-type input predicates.

Contract example

import {MarkdownSpeech} from '/arcane/modules/MarkdownSpeech.js';

const speechText = new MarkdownSpeech();
console.log(speechText.append('*'));
console.log(speechText.append('*Hello.', true));

Related reference

No direct Core call is claimed for this artifact. Any injected provider or consuming module retains its own documented authority.

• Module index