Axial

ConsoleModule

PackageAxial.Console

Summary

NameSignatureSynopsis
Operations
serviceConsole.service Reads the console service from the environment.
inputConsole.input No description available.
outputConsole.output No description available.
errorConsole.error No description available.
inputEncodingConsole.inputEncoding No description available.
setInputEncodingConsole.setInputEncoding valueNo description available.
outputEncodingConsole.outputEncoding No description available.
setOutputEncodingConsole.setOutputEncoding valueNo description available.
isInputRedirectedConsole.isInputRedirected No description available.
isOutputRedirectedConsole.isOutputRedirected No description available.
isErrorRedirectedConsole.isErrorRedirected No description available.
keyAvailableConsole.keyAvailable No description available.
readConsole.read No description available.
readLineConsole.readLine No description available.
readKeyConsole.readKey interceptNo description available.
writeConsole.write valueNo description available.
writeLineConsole.writeLine valueNo description available.
writeErrorConsole.writeError valueNo description available.
writeErrorLineConsole.writeErrorLine valueNo description available.
openStandardInputConsole.openStandardInput No description available.
openStandardOutputConsole.openStandardOutput No description available.
openStandardErrorConsole.openStandardError No description available.
clearConsole.clear No description available.
beepConsole.beep No description available.
resetColorConsole.resetColor No description available.
foregroundColorConsole.foregroundColor No description available.
setForegroundColorConsole.setForegroundColor valueNo description available.
backgroundColorConsole.backgroundColor No description available.
setBackgroundColorConsole.setBackgroundColor valueNo description available.
cursorPositionConsole.cursorPosition No description available.
setCursorPositionConsole.setCursorPosition left topNo description available.
cursorVisibleConsole.cursorVisible No description available.
setCursorVisibleConsole.setCursorVisible valueNo description available.
titleConsole.title No description available.
setTitleConsole.setTitle valueNo description available.
treatControlCAsInputConsole.treatControlCAsInput No description available.
setTreatControlCAsInputConsole.setTreatControlCAsInput valueNo description available.
liveConsole.live Creates a live console service backed by .

Operations

kind:member

service

Console.service
Member
Reads the console service from the environment.

Returns

Flow<'env, 'error, IConsole>
kind:member

input

Console.input
Member

Returns

Flow<'env, 'error, TextReader>
kind:member

output

Console.output
Member

Returns

Flow<'env, 'error, TextWriter>
kind:member

error

Console.error
Member

Returns

Flow<'env, 'error, TextWriter>
kind:member

inputEncoding

Console.inputEncoding
Member

Returns

Flow<'env, 'error, Encoding>
kind:member

setInputEncoding

Console.setInputEncoding value
Member

Parameters

NameTypeDescription
valueEncoding

Returns

Flow<'env, 'error, unit>
kind:member

outputEncoding

Console.outputEncoding
Member

Returns

Flow<'env, 'error, Encoding>
kind:member

setOutputEncoding

Console.setOutputEncoding value
Member

Parameters

NameTypeDescription
valueEncoding

Returns

Flow<'env, 'error, unit>
kind:member

isInputRedirected

Console.isInputRedirected
Member

Returns

Flow<'env, 'error, bool>
kind:member

isOutputRedirected

Console.isOutputRedirected
Member

Returns

Flow<'env, 'error, bool>
kind:member

isErrorRedirected

Console.isErrorRedirected
Member

Returns

Flow<'env, 'error, bool>
kind:member

keyAvailable

Console.keyAvailable
Member

Returns

Flow<'env, 'error, bool>
kind:member

read

Console.read
Member

Returns

Flow<'env, 'error, int>
kind:member

readLine

Console.readLine
Member

Returns

Flow<'env, 'error, string>
kind:member

readKey

Console.readKey intercept
Member

Parameters

NameTypeDescription
interceptbool

Returns

Flow<'env, 'error, ConsoleKeyInfo>
kind:member

write

Console.write value
Member

Parameters

NameTypeDescription
valuestring

Returns

Flow<'env, 'error, unit>
kind:member

writeLine

Console.writeLine value
Member

Parameters

NameTypeDescription
valuestring

Returns

Flow<'env, 'error, unit>
kind:member

writeError

Console.writeError value
Member

Parameters

NameTypeDescription
valuestring

Returns

Flow<'env, 'error, unit>
kind:member

writeErrorLine

Console.writeErrorLine value
Member

Parameters

NameTypeDescription
valuestring

Returns

Flow<'env, 'error, unit>
kind:member

openStandardInput

Console.openStandardInput
Member

Returns

Flow<'env, 'error, Stream>
kind:member

openStandardOutput

Console.openStandardOutput
Member

Returns

Flow<'env, 'error, Stream>
kind:member

openStandardError

Console.openStandardError
Member

Returns

Flow<'env, 'error, Stream>
kind:member

clear

Console.clear
Member

Returns

Flow<'env, 'error, unit>
kind:member

beep

Console.beep
Member

Returns

Flow<'env, 'error, unit>
kind:member

resetColor

Console.resetColor
Member

Returns

Flow<'env, 'error, unit>
kind:member

foregroundColor

Console.foregroundColor
Member

Returns

Flow<'env, 'error, ConsoleColor>
kind:member

setForegroundColor

Console.setForegroundColor value
Member

Parameters

NameTypeDescription
valueConsoleColor

Returns

Flow<'env, 'error, unit>
kind:member

backgroundColor

Console.backgroundColor
Member

Returns

Flow<'env, 'error, ConsoleColor>
kind:member

setBackgroundColor

Console.setBackgroundColor value
Member

Parameters

NameTypeDescription
valueConsoleColor

Returns

Flow<'env, 'error, unit>
kind:member

cursorPosition

Console.cursorPosition
Member

Returns

Flow<'env, 'error, (int * int)>
kind:member

setCursorPosition

Console.setCursorPosition left top
Member

Parameters

NameTypeDescription
leftint
topint

Returns

Flow<'env, 'error, unit>
kind:member

cursorVisible

Console.cursorVisible
Member

Returns

Flow<'env, 'error, bool>
kind:member

setCursorVisible

Console.setCursorVisible value
Member

Parameters

NameTypeDescription
valuebool

Returns

Flow<'env, 'error, unit>
kind:member

title

Console.title
Member

Returns

Flow<'env, 'error, string>
kind:member

setTitle

Console.setTitle value
Member

Parameters

NameTypeDescription
valuestring

Returns

Flow<'env, 'error, unit>
kind:member

treatControlCAsInput

Console.treatControlCAsInput
Member

Returns

Flow<'env, 'error, bool>
kind:member

setTreatControlCAsInput

Console.setTreatControlCAsInput value
Member

Parameters

NameTypeDescription
valuebool

Returns

Flow<'env, 'error, unit>
kind:member

live

Console.live
Member
Creates a live console service backed by Console.

Returns

IConsole