sdk

Interfaces

ConfigProps

Properties

Property	Type
initialConfig	LoadedBaetaConfig
watchConfig?	boolean

---

ErrorsProps

Properties

Property	Type
errors?	TextOutput[]
warnings?	TextOutput[]

---

LayoutProps

Properties

Property	Type
color?	LiteralUnion<keyof ForegroundColor, string>
loading?	boolean
time?	number
timePrefix?	string
title?	string

---

LoadedBaetaConfig

Properties

Property	Type
config	BaetaOptions
location	string
relativeLocation	string

---

TimeProps

Properties

Property	Type
prefix?	string
value?	number

Type Aliases

ConfigEventMap

ConfigEventMap: object

Type declaration

Name	Type
update	[LoadedBaetaConfig]

---

TextOutput

TextOutput: object

Type declaration

Name	Type
id	string
text	string

Variables

errorNamespace

const errorNamespace: string

Functions

ConfigProvider()

ConfigProvider(props): Element

Parameters

Parameter	Type
props	PropsWithChildren<ConfigProps>

Returns

Element

---

ConfigProviderBase()

ConfigProviderBase(props): Element

Parameters

Parameter	Type
props	PropsWithChildren<ConfigProps>

Returns

Element

---

ConfigStatus()

ConfigStatus(): null | Element

Returns

null | Element

---

createCommand()

createCommand<Args>(options): CommandModule<Args, Args>

Type Parameters

Type Parameter
Args

Parameters

Parameter	Type
options	CommandModule<Args, Args>

Returns

CommandModule<Args, Args>

---

Errors()

Errors(props): Element

Parameters

Parameter	Type
props	ErrorsProps

Returns

Element

---

Layout()

Layout(props): Element

Parameters

Parameter	Type
props	PropsWithChildren<LayoutProps>

Returns

Element

---

makeErrorMessage()

makeErrorMessage(message, bold): string

Parameters

Parameter	Type	Default value
message	string	undefined
bold	boolean	false

Returns

string

---

makeErrorOutput()

makeErrorOutput(id, message, bold): object

Parameters

Parameter	Type	Default value
id	string	undefined
message	string	undefined
bold	boolean	false

Returns

object

Name	Type
id	string
text	string

---

renderComponent()

renderComponent<P>(Component, props, configProps?): void

Type Parameters

Type Parameter
P extends object

Parameters

Parameter	Type
Component	FunctionComponent<P>
props	P
configProps?	ConfigProps

Returns

void

---

renderComponentWithoutConfig()

renderComponentWithoutConfig<P>(component, props?): void

Type Parameters

Type Parameter
P extends object

Parameters

Parameter	Type
component	FunctionComponent<P>
props?	null | P

Returns

void

---

Spinner()

Spinner(): Element

Returns

Element

---

Time()

Time(props): null | Element

Parameters

Parameter	Type
props	TimeProps

Returns

null | Element

---

useConfig()

useConfig(): object

Returns

object

Name	Type
config	BaetaOptions
events	EventEmitter<ConfigEventMap>
location	string
relativeLocation	string

---

useConfigStore()

useConfigStore(props): object

Parameters

Parameter	Type
props	ConfigProps

Returns

object

Name	Type
config	BaetaOptions
events	EventEmitter<ConfigEventMap>
location	string
relativeLocation	string