Narra

Reference

std/terminal

std/terminal

Detect a terminal and style text for it.

narra
import * as Terminal from "std/terminal"

The guide teaches it in chapter 13, The standard library.

This page is generated by scripts/std/generate.nra from narrac query --json interface std/terminal. Do not edit it.

Types

Stream

narra
export enum Stream {
  Stdin
  Stdout
  Stderr
}

Functions: isTerminal, columns, useColor.

Color

narra
export enum Color {
  Default
  Black
  Red
  Green
  Yellow
  Blue
  Magenta
  Cyan
  White
  BrightBlack
  BrightRed
  BrightGreen
  BrightYellow
  BrightBlue
  BrightMagenta
  BrightCyan
  BrightWhite
  Ansi256(index: u8)
  Rgb(red: u8, green: u8, blue: u8)
}

Style

narra
export struct Style {
  foreground: Color
  background: Color
  bold: bool
  dim: bool
  italic: bool
  underline: bool
  inverse: bool
  strikethrough: bool
}

Functions: style.

Functions

isTerminal

narra
export function isTerminal(stream: Stream): bool uses io

Effects: io.

columns

narra
export function columns(stream: Stream): Option<int> uses io

Effects: io.

useColor

narra
export function useColor(stream: Stream): bool uses io, alloc

Effects: io, alloc.

bold

narra
export function bold(text: string): string uses alloc

Effects: alloc.

dim

narra
export function dim(text: string): string uses alloc

Effects: alloc.

italic

narra
export function italic(text: string): string uses alloc

Effects: alloc.

underline

narra
export function underline(text: string): string uses alloc

Effects: alloc.

inverse

narra
export function inverse(text: string): string uses alloc

Effects: alloc.

strikethrough

narra
export function strikethrough(text: string): string uses alloc

Effects: alloc.

black

narra
export function black(text: string): string uses alloc

Effects: alloc.

red

narra
export function red(text: string): string uses alloc

Effects: alloc.

green

narra
export function green(text: string): string uses alloc

Effects: alloc.

yellow

narra
export function yellow(text: string): string uses alloc

Effects: alloc.

blue

narra
export function blue(text: string): string uses alloc

Effects: alloc.

magenta

narra
export function magenta(text: string): string uses alloc

Effects: alloc.

cyan

narra
export function cyan(text: string): string uses alloc

Effects: alloc.

white

narra
export function white(text: string): string uses alloc

Effects: alloc.

gray

narra
export function gray(text: string): string uses alloc

Effects: alloc.

bgBlack

narra
export function bgBlack(text: string): string uses alloc

Effects: alloc.

bgRed

narra
export function bgRed(text: string): string uses alloc

Effects: alloc.

bgGreen

narra
export function bgGreen(text: string): string uses alloc

Effects: alloc.

bgYellow

narra
export function bgYellow(text: string): string uses alloc

Effects: alloc.

bgBlue

narra
export function bgBlue(text: string): string uses alloc

Effects: alloc.

bgMagenta

narra
export function bgMagenta(text: string): string uses alloc

Effects: alloc.

bgCyan

narra
export function bgCyan(text: string): string uses alloc

Effects: alloc.

bgWhite

narra
export function bgWhite(text: string): string uses alloc

Effects: alloc.

style

narra
export function style(text: string, look: Style): string uses alloc

Effects: alloc.

stripStyles

narra
export function stripStyles(text: string): string uses alloc

Effects: alloc.