@kismet.ts/shared / Exports

@kismet.ts/shared

Table of contents

Namespaces

• Constants

Classes

• KismetError
• KismetItemFormatter
• Logger
• RemoteKismet

Interfaces

• IResponse
• LogLevel
• LogOptions
• LoggerOptions
• RemoteKismetAssetFetchOptions

Type Aliases

• ArrayUnion
• Awaitable
• ClassConstructor
• DeprecateFunction
• Enum
• If
• KismetFormatterInput
• LogHandlerReturnType
• LogHandlerStream
• MessageKey
• MessageParams
• RemoteKismetAssetType

Variables

• typeguards

Functions

• arrayUnionInput
• browserDeprecate
• capitalize
• cast
• constructItem
• convertVariablesRecordToArray
• destructureDefaultProperty
• destructureProperty
• filterEmptyLines
• filterMultipleEmptyLines
• getNodeType
• groupByProperty
• indent
• isType
• mapObjectKeys
• pick
• pickExclude
• quote
• readArchetype

Type Aliases

ArrayUnion

Ƭ ArrayUnion<T>: T | T[]

Type parameters

Name
T

Defined in

util/types.ts:1

---

Awaitable

Ƭ Awaitable<T>: Promise<T> | T

Type parameters

Name	Type
T	void

Defined in

util/types.ts:3

---

ClassConstructor

Ƭ ClassConstructor<T, U>: (...args: U) => T

Type parameters

Name	Type
T	unknown
U	extends unknown[] = []

Type declaration

• (...args)

Parameters

Name	Type
...args	U

Defined in

util/types.ts:5

---

DeprecateFunction

Ƭ DeprecateFunction: (fn: Function, msg: string, code?: string) => void

Type declaration

▸ (fn, msg, code?): void

Parameters

Name	Type
fn	Function
msg	string
code?	string

Returns

void

Defined in

debug/deprecate.ts:1

---

Enum

Ƭ Enum<T>: T | `${T}`

Type parameters

Name	Type
T	extends string

Defined in

util/types.ts:9

---

If

Ƭ If<T, U, P>: T extends true ? U : P

Type parameters

Name	Type
T	extends boolean
U	U
P	undefined

Defined in

util/types.ts:11

---

KismetFormatterInput

Ƭ KismetFormatterInput: string | number | boolean | null | undefined

Defined in

kismet/functions.ts:4

---

LogHandlerReturnType

Ƭ LogHandlerReturnType: "completed" | "error" | "log"

Defined in

debug/logger.ts:1

---

LogHandlerStream

Ƭ LogHandlerStream: "stdout" | "stderr" | "http"

Defined in

debug/logger.ts:6

---

MessageKey

Ƭ MessageKey: keyof typeof Messages

Defined in

error/Messages.ts:27

---

MessageParams

Ƭ MessageParams<T>: typeof Messages[T] extends (...args: any[]) => any ? Parameters<typeof Messages[T]> : []

Type parameters

Name	Type
T	extends MessageKey

Defined in

error/Messages.ts:29

---

RemoteKismetAssetType

Ƭ RemoteKismetAssetType: "classes" | "nodes" | "blender" | "itemdb"

Defined in

remote/nodes.ts:1

Variables

typeguards

• Const typeguards: Object

Type declaration

Name	Type
isBoolean	(t: unknown) => t is boolean
isString	(t: unknown) => t is string

Defined in

util/util.ts:174

Functions

arrayUnionInput

▸ arrayUnionInput<T>(input): T[]

Type parameters

Name
T

Parameters

Name	Type
input	ArrayUnion<T>

Returns

T[]

Defined in

util/util.ts:4

---

browserDeprecate

▸ browserDeprecate(...args): () => any

Parameters

Name	Type
...args	[fn: Function, msg: string, code?: string]

Returns

fn

▸ (): any

Returns

any

Defined in

debug/deprecate.ts:3

---

capitalize

▸ capitalize(input?): string | null

Parameters

Name	Type
input?	string

Returns

string | null

Defined in

util/util.ts:128

---

cast

▸ cast<T>(input, type?): T

Type parameters

Name
T

Parameters

Name	Type
input	unknown
type?	"number" | "boolean"

Returns

T

Defined in

util/util.ts:133

---

constructItem

▸ constructItem<R, T>(item): R

Type parameters

Name	Type
R	extends A<R>
T	extends typeof A

Parameters

Name	Type
item	T

Returns

R

Defined in

kismet/functions.ts:116

---

convertVariablesRecordToArray

▸ convertVariablesRecordToArray<T>(variables): [string, T][]

Type parameters

Name	Type
T	undefined

Parameters

Name	Type
variables	Record<string, T>

Returns

[string, T][]

Defined in

kismet/functions.ts:72

---

destructureDefaultProperty

▸ destructureDefaultProperty(input): undefined | [string, string][]

Parameters

Name	Type
input	string

Returns

undefined | [string, string][]

Defined in

kismet/destructure.ts:1

---

destructureProperty

▸ destructureProperty(rawInput): [string, string]

Parameters

Name	Type
rawInput	string

Returns

[string, string]

Defined in

kismet/destructure.ts:18

---

filterEmptyLines

▸ filterEmptyLines(input): string

Parameters

Name	Type
input	string | string[]

Returns

string

Defined in

util/util.ts:8

---

filterMultipleEmptyLines

▸ filterMultipleEmptyLines(content): string

Parameters

Name	Type
content	string

Returns

string

Defined in

util/util.ts:17

---

getNodeType

▸ getNodeType(Class): NodeType | undefined

Get the node type for a given item class

Parameters

Name	Type	Description
Class	string	The input class of the item

Returns

NodeType | undefined

The node type. Sequences are not included

Defined in

kismet/functions.ts:85

---

groupByProperty

▸ groupByProperty<T>(input, propertyName): T[][]

Type parameters

Name	Type
T	extends Record<string, unknown>

Parameters

Name	Type
input	T[]
propertyName	keyof T

Returns

T[][]

Defined in

util/util.ts:25

---

indent

▸ indent(repeat?): string

Create an indent with 4 spaces

Parameters

Name	Type	Default value	Description
repeat?	number	1	The amount of indents

Returns

string

Defined in

util/util.ts:116

---

isType

▸ isType(type, input, keys?): boolean

Parameters

Name	Type
type	objectType
input	unknown
keys?	string[]

Returns

boolean

Defined in

util/util.ts:61

---

mapObjectKeys

▸ mapObjectKeys<T, C>(object, fn): C[][]

Map over the keys of an object.

Can be seen as object[string].map(fn)

Type parameters

Name
T
C

Parameters

Name	Type
object	Record<string, T[]>
fn	(obj: T, i: number, array: T[]) => C

Returns

C[][]

Defined in

util/util.ts:103

---

pick

▸ pick<T, K>(obj, keys): Pick<T, K[number]>

Type parameters

Name	Type
T	extends Record<string, unknown>
K	extends keyof T[]

Parameters

Name	Type
obj	T
keys	K

Returns

Pick<T, K[number]>

Defined in

util/util.ts:149

---

pickExclude

▸ pickExclude<T, K>(obj, keys): Pick<T, Exclude<keyof T, K[number]>>

Type parameters

Name	Type
T	extends Record<string, unknown>
K	extends keyof T[]

Parameters

Name	Type
obj	T
keys	K

Returns

Pick<T, Exclude<keyof T, K[number]>>

Defined in

util/util.ts:163

---

quote

▸ quote(value): string

Surround the value with " quotes

Parameters

Name	Type
value	string

Returns

string

Defined in

util/util.ts:124

---

readArchetype

▸ readArchetype(archetype): Record<"Class" | "ClassType" | "Package", string>

Get the class, class type and package name from an archetype

Parameters

Name	Type	Description
archetype	string	The archetype of the item

Returns

Record<"Class" | "ClassType" | "Package", string>

Defined in

kismet/functions.ts:124