Module: Core

Iniquity Core

summary This is the Iniquity core bbs library. It’s the foundation of any Iniquity application.

example

import BBS from "@iniquitybbs/core"

const mybbs = new BBS()

myIniquity.artwork({ filename: "./path/to/textfile.ans" }).render({ speed: 10 })

myIniquity.say("Pretty cool, right???".newlines(2).color("bright cyan").center()).pause()

myIniquity.disconnect()

Table of contents

References

• IQCoreAssets

Namespaces

• IQ

Enumerations

• IQFrameColorOptions
• IQModuleACLS

Classes

• Artwork
• Group
• IQ
• IQBaseConfig
• IQFrame
• IQMenu
• Iniquity
• Network
• Text
• User

Interfaces

• IBBSPrintFunctions
• IBBSSayFunctions
• IMenuCommand
• IMenuCommands
• IQArtworkOptions
• IQArtworkRenderFunctions
• IQArtworkRenderOptions
• IQCursorChainableMethods
• IQCursorOptions
• IQFrameOptions
• IQMenuLoopMessageResponse
• IQMenuLoopOptions
• IQMenuOptions
• IQMenuPromptFunctions
• IQMenuPromptOptions
• IQModuleOptions
• IQModuleRuntimeOptions
• IQPauseOptions
• IQPrintOptions
• IQReactorOptions
• IQStringUtils
• IQTermInfoObject
• IQWaitOptions
• IUserOptions

Variables

• default

Functions

• IQModule
• IQModuleRuntime
• IQReactor
• cursor
• gotoxy
• pause
• randomAsset
• say
• wait

References

IQCoreAssets

• IQCoreAssets: Object

Defined in

core/src/index.ts:1345

Variables

default

• default: Iniquity

The globally scoped intance of iniquity

Defined in

core/src/index.ts:1296

Functions

IQModule

▸ IQModule(options): (constructor: Function) => void

An experimental Iniquity module decorator for bbs modules

author ispyhumanfly

Parameters

Name	Type
options	IQModuleOptions

Returns

fn

▸ (constructor): void

Parameters

Name	Type
constructor	Function

Returns

void

Defined in

core/src/index.ts:1315

---

IQModuleRuntime

▸ IQModuleRuntime(options?): any

The IQ script executed as part of a module.

Parameters

Name	Type
options?	IQModuleRuntimeOptions

Returns

any

Defined in

core/src/index.ts:1335

---

IQReactor

▸ IQReactor(dataObj): IQReactorOptions

Iniquity reactive data model

see https://www.monterail.com/blog/2016/how-to-build-a-reactive-engine-in-javascript-part-1-observable-objects

Parameters

Name	Type
dataObj	any

Returns

IQReactorOptions

Defined in

core/src/index.ts:102

---

cursor

▸ cursor(options?): IQCursorChainableMethods

A pretty cool method for working with cursor movement.

example cursor().down(10).up(12).down().up().down().left(1).right(20).down(12).up(14)

Parameters

Name	Type
options?	IQCursorOptions

Returns

IQCursorChainableMethods

Defined in

core/src/index.ts:1144

---

gotoxy

▸ gotoxy(x, y): void

Parameters

Name	Type
x	number
y	number

Returns

void

Defined in

core/src/index.ts:1148

---

pause

▸ pause(options?): void

Parameters

Name	Type
options?	IQPauseOptions

Returns

void

Defined in

core/src/index.ts:1152

---

randomAsset

▸ randomAsset(assets): string

Return a single asset random selected from an array of IQCoreAssets

Parameters

Name	Type	Description
assets	string[]	An array of IQCoreAssets to choose from

Returns

string

The randomly selected asset

Defined in

core/src/index.ts:1424

---

say

▸ say(options?): IBBSSayFunctions

Say whatever you want, but to the screen

example say(“are we making it here?”).pause()

Parameters

Name	Type
options?	any

Returns

IBBSSayFunctions

Defined in

core/src/index.ts:1122

---

wait

▸ wait(options?): void

Parameters

Name	Type
options?	number | IQWaitOptions

Returns

void

Defined in

core/src/index.ts:1155