Axial

ConsoleModule

PackageAxial.Console

Summary

NameSignatureSynopsis
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 .

service

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

Returns

Flow<'env, 'error, IConsole>

input

Console.input
Member

Returns

Flow<'env, 'error, TextReader>

output

Console.output
Member

Returns

Flow<'env, 'error, TextWriter>

error

Console.error
Member

Returns

Flow<'env, 'error, TextWriter>

inputEncoding

Console.inputEncoding
Member

Returns

Flow<'env, 'error, Encoding>

setInputEncoding

Console.setInputEncoding value
Member

Parameters

NameTypeDescription
valueEncoding

Returns

Flow<'env, 'error, unit>

outputEncoding

Console.outputEncoding
Member

Returns

Flow<'env, 'error, Encoding>

setOutputEncoding

Console.setOutputEncoding value
Member

Parameters

NameTypeDescription
valueEncoding

Returns

Flow<'env, 'error, unit>

isInputRedirected

Console.isInputRedirected
Member

Returns

Flow<'env, 'error, bool>

isOutputRedirected

Console.isOutputRedirected
Member

Returns

Flow<'env, 'error, bool>

isErrorRedirected

Console.isErrorRedirected
Member

Returns

Flow<'env, 'error, bool>

keyAvailable

Console.keyAvailable
Member

Returns

Flow<'env, 'error, bool>

read

Console.read
Member

Returns

Flow<'env, 'error, int>

readLine

Console.readLine
Member

Returns

Flow<'env, 'error, string>

readKey

Console.readKey intercept
Member

Parameters

NameTypeDescription
interceptbool

Returns

Flow<'env, 'error, ConsoleKeyInfo>

write

Console.write value
Member

Parameters

NameTypeDescription
valuestring

Returns

Flow<'env, 'error, unit>

writeLine

Console.writeLine value
Member

Parameters

NameTypeDescription
valuestring

Returns

Flow<'env, 'error, unit>

writeError

Console.writeError value
Member

Parameters

NameTypeDescription
valuestring

Returns

Flow<'env, 'error, unit>

writeErrorLine

Console.writeErrorLine value
Member

Parameters

NameTypeDescription
valuestring

Returns

Flow<'env, 'error, unit>

openStandardInput

Console.openStandardInput
Member

Returns

Flow<'env, 'error, Stream>

openStandardOutput

Console.openStandardOutput
Member

Returns

Flow<'env, 'error, Stream>

openStandardError

Console.openStandardError
Member

Returns

Flow<'env, 'error, Stream>

clear

Console.clear
Member

Returns

Flow<'env, 'error, unit>

beep

Console.beep
Member

Returns

Flow<'env, 'error, unit>

resetColor

Console.resetColor
Member

Returns

Flow<'env, 'error, unit>

foregroundColor

Console.foregroundColor
Member

Returns

Flow<'env, 'error, ConsoleColor>

setForegroundColor

Console.setForegroundColor value
Member

Parameters

NameTypeDescription
valueConsoleColor

Returns

Flow<'env, 'error, unit>

backgroundColor

Console.backgroundColor
Member

Returns

Flow<'env, 'error, ConsoleColor>

setBackgroundColor

Console.setBackgroundColor value
Member

Parameters

NameTypeDescription
valueConsoleColor

Returns

Flow<'env, 'error, unit>

cursorPosition

Console.cursorPosition
Member

Returns

Flow<'env, 'error, (int * int)>

setCursorPosition

Console.setCursorPosition left top
Member

Parameters

NameTypeDescription
leftint
topint

Returns

Flow<'env, 'error, unit>

cursorVisible

Console.cursorVisible
Member

Returns

Flow<'env, 'error, bool>

setCursorVisible

Console.setCursorVisible value
Member

Parameters

NameTypeDescription
valuebool

Returns

Flow<'env, 'error, unit>

title

Console.title
Member

Returns

Flow<'env, 'error, string>

setTitle

Console.setTitle value
Member

Parameters

NameTypeDescription
valuestring

Returns

Flow<'env, 'error, unit>

treatControlCAsInput

Console.treatControlCAsInput
Member

Returns

Flow<'env, 'error, bool>

setTreatControlCAsInput

Console.setTreatControlCAsInput value
Member

Parameters

NameTypeDescription
valuebool

Returns

Flow<'env, 'error, unit>

live

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

Returns

IConsole