iniquity

A re-imagining of the iconic BBS software.

View on GitHub

Module: runtime/mci/text-styles

Text Styles

Summary

ENiGMA-inspired text transformations (l33t, title, upper, etc.)

Table of contents

Classes

Type Aliases

Variables

Functions

Type Aliases

TextStyleFunction

Ƭ TextStyleFunction: (text: string) => string

Type declaration

▸ (text): string

Parameters
Name Type
text string
Returns

string

Defined in

core/src/mci/text-styles.ts:42


TextStyleName

Ƭ TextStyleName: "normal" | "upper" | "lower" | "title" | "firstLower" | "smallVowels" | "bigVowels" | "smallI" | "mixed" | "l33t" | "reverse" | "alternating" | "wave"

Defined in

core/src/mci/text-styles.ts:27

Variables

TEXT_STYLES

• Const TEXT_STYLES: Record<TextStyleName, TextStyleFunction>

Defined in

core/src/mci/text-styles.ts:180

Functions

applyTextStyle

▸ applyTextStyle(text, styleName): string

Parameters

Name Type
text string
styleName string

Returns

string

Defined in

core/src/mci/text-styles.ts:244


getTextStyle

▸ getTextStyle(name): TextStyleFunction | undefined

Parameters

Name Type
name string

Returns

TextStyleFunction | undefined

Defined in

core/src/mci/text-styles.ts:230


isValidTextStyle

▸ isValidTextStyle(name): boolean

Parameters

Name Type
name string

Returns

boolean

Defined in

core/src/mci/text-styles.ts:256


listTextStyles

▸ listTextStyles(): TextStyleName[]

Returns

TextStyleName[]

Defined in

core/src/mci/text-styles.ts:252


styleAlternating

▸ styleAlternating(text): string

Parameters

Name Type
text string

Returns

string

Defined in

core/src/mci/text-styles.ts:151


styleBigVowels

▸ styleBigVowels(text): string

Parameters

Name Type
text string

Returns

string

Defined in

core/src/mci/text-styles.ts:103


styleFirstLower

▸ styleFirstLower(text): string

Parameters

Name Type
text string

Returns

string

Defined in

core/src/mci/text-styles.ts:85


styleL33t

▸ styleL33t(text): string

Parameters

Name Type
text string

Returns

string

Defined in

core/src/mci/text-styles.ts:139


styleLower

▸ styleLower(text): string

Parameters

Name Type
text string

Returns

string

Defined in

core/src/mci/text-styles.ts:75


styleMixed

▸ styleMixed(text): string

Parameters

Name Type
text string

Returns

string

Defined in

core/src/mci/text-styles.ts:127


styleNormal

▸ styleNormal(text): string

Parameters

Name Type
text string

Returns

string

Defined in

core/src/mci/text-styles.ts:67


styleReverse

▸ styleReverse(text): string

Parameters

Name Type
text string

Returns

string

Defined in

core/src/mci/text-styles.ts:147


styleSmallI

▸ styleSmallI(text): string

Parameters

Name Type
text string

Returns

string

Defined in

core/src/mci/text-styles.ts:115


styleSmallVowels

▸ styleSmallVowels(text): string

Parameters

Name Type
text string

Returns

string

Defined in

core/src/mci/text-styles.ts:91


styleTitle

▸ styleTitle(text): string

Parameters

Name Type
text string

Returns

string

Defined in

core/src/mci/text-styles.ts:79


styleUpper

▸ styleUpper(text): string

Parameters

Name Type
text string

Returns

string

Defined in

core/src/mci/text-styles.ts:71


styleWave

▸ styleWave(text): string

Parameters

Name Type
text string

Returns

string

Defined in

core/src/mci/text-styles.ts:165