Options
All
  • Public
  • Public/Protected
  • All
Menu

roblox-api-raw

Index

Type aliases

Member

Functions

getApiDump

  • getApiDump(version?: string): Promise<ApiDump>
  • Retrieves the Roblox API dump for the given version. If no version is supplies, getApiDump simply retrieves the latest version.

    Parameters

    • Optional version: string

      Optional. The Roblox version to use. Defaults to the latest version.

    Returns Promise<ApiDump>

getFromSetup

  • getFromSetup(path: string): Promise<string>

getLatestVersion

  • getLatestVersion(): Promise<string>
  • Retrieves the latest version of Roblox Studio.

    Returns Promise<string>

isApiDump

  • isApiDump(value: unknown): value is ApiDump

isCallback

  • isCallback(value: unknown): value is Callback

isClass

  • isClass(value: unknown): value is Class

isEnum

  • isEnum(value: unknown): value is Enum

isEnumItem

  • isEnumItem(value: unknown): value is EnumItem

isEvent

  • isEvent(value: unknown): value is Event

isFunction

  • isFunction(value: unknown): value is Function

isItem

  • isItem(value: unknown): value is Item

isMember

  • isMember(value: unknown): value is Member

isMemberBase

  • isMemberBase(value: unknown): value is MemberBase<MemberType>

isMemberType

  • isMemberType(value: unknown): value is MemberType

isParameter

  • isParameter(value: unknown): value is Parameter

isProperty

  • isProperty(value: unknown): value is Property

isPropertySecurity

  • isPropertySecurity(value: unknown): value is PropertySecurity

isPropertySerialization

  • isPropertySerialization(value: unknown): value is PropertySerialization

isType

  • isType(value: unknown): value is Type

Generated using TypeDoc