API Reference

Typeclass

Shared runtime and type utilities.

Overview

Low-level shared types and utilities used throughout core/state/parser packages.
Quick facts
Kind
class
Module
types
Members
20
Package
@rs-x/core

Import

import { Type } from '@rs-x/core';

Example

import { Type } from '@rs-x/core';

const instance = new Type(...args);

Members

20 members in this class.

cast
methodpublic
public static cast<T>(instance: unknown): T

Parameters

NameTypeRequired
instanceunknownrequired

Returns

T

getConstructorName
methodpublic
public static getConstructorName(value: unknown): string

Parameters

NameTypeRequired
valueunknownrequired

Returns

string

getPropertyDescriptor
methodpublic
public static getPropertyDescriptor<T>(
  root: unknown,
  name: keyof T
): IPropertyDescriptor

Parameters

NameTypeRequired
rootunknownrequired
namekeyof Trequired
getPropertyDescriptorType
methodpublic
public static getPropertyDescriptorType(
  // target: unknown,
  // name: string,
  propertyDescriptor: PropertyDescriptor
): PropertyDescriptorType

Parameters

NameTypeRequired
// target: unknownunknownrequired
// name: stringunknownrequired
propertyDescriptorPropertyDescriptorrequired
hasOwnPropertyInPrototypeChain
methodpublic
public static hasOwnPropertyInPrototypeChain(
  target: unknown,
  key: PropertyKey
): boolean

Parameters

NameTypeRequired
targetunknownrequired
keyPropertyKeyrequired

Returns

boolean

hasProperty
methodpublic
public static hasProperty(
  root: unknown,
  name: string
): boolean

Parameters

NameTypeRequired
rootunknownrequired
namestringrequired

Returns

boolean

isArrowFunction
methodpublic
public static isArrowFunction( object: unknown): object is (...args: unknown[]) => unknown

Parameters

NameTypeRequired
objectunknownrequired

Returns

object is (...args: unknown[]) => unknown

isEmpty
methodpublic
public static isEmpty(value: unknown): boolean

Parameters

NameTypeRequired
valueunknownrequired

Returns

boolean

isFunction
methodpublic
public static isFunction(value: unknown): value is AnyFunction

Parameters

NameTypeRequired
valueunknownrequired

Returns

value is AnyFunction

isIterableCollection
methodpublic
public static isIterableCollection(value: unknown): boolean

Parameters

NameTypeRequired
valueunknownrequired

Returns

boolean

isMethod
methodpublic
public static isMethod(value: unknown): boolean

Parameters

NameTypeRequired
valueunknownrequired

Returns

boolean

isNullOrUndefined
methodpublic
public static isNullOrUndefined(value: unknown): boolean

Parameters

NameTypeRequired
valueunknownrequired

Returns

boolean

isPlainObject
methodpublic
public static isPlainObject(value: unknown): value is PlainObject

Parameters

NameTypeRequired
valueunknownrequired

Returns

value is PlainObject

isPositiveInteger
methodpublic
public static isPositiveInteger(value: unknown): boolean

Parameters

NameTypeRequired
valueunknownrequired

Returns

boolean

isPositiveIntegerString
methodpublic
public static isPositiveIntegerString(value: unknown): boolean

Parameters

NameTypeRequired
valueunknownrequired

Returns

boolean

isReadonlyProperty
methodpublic
public static isReadonlyProperty(
  target: unknown,
  key: unknown
): boolean

Parameters

NameTypeRequired
targetunknownrequired
keyunknownrequired

Returns

boolean

isString
methodpublic
public static isString(value: unknown): value is string

Parameters

NameTypeRequired
valueunknownrequired

Returns

value is string

toObject
methodpublic
public static toObject( context: unknown): Record<string, unknown> | undefined

Parameters

NameTypeRequired
contextunknownrequired

Returns

Record<string, unknown> | undefined

walkObjectBottomToTop
methodpublic
public static walkObjectBottomToTop(
  object: object,
  visit: (parent: object, key: string, value: unknown) => void,
  recursive: boolean
): void

Parameters

NameTypeRequired
objectobjectrequired
visit(parent: object, key: string, value: unknown)required

Returns

void

walkObjectTopToBottom
methodpublic
public static walkObjectTopToBottom(
  object: object,
  visit: (parent: object, key: string, value: unknown) => void,
  recursive: boolean
): void

Parameters

NameTypeRequired
objectobjectrequired
visit(parent: object, key: string, value: unknown)required

Returns

void