Functions
getApiDump
- getApiDump(version?: string): Promise<ApiDump>
-
Parameters
Returns Promise<ApiDump>
getFromSetup
- getFromSetup(path: string): Promise<string>
-
Parameters
Returns Promise<string>
getLatestVersion
- getLatestVersion(): Promise<string>
isApiDump
- isApiDump(value: unknown): value is ApiDump
-
Parameters
Returns value is ApiDump
isCallback
- isCallback(value: unknown): value is Callback
-
Parameters
Returns value is Callback
isClass
- isClass(value: unknown): value is Class
-
Parameters
Returns value is Class
isEnum
- isEnum(value: unknown): value is Enum
-
Parameters
Returns value is Enum
isEnumItem
- isEnumItem(value: unknown): value is EnumItem
-
Parameters
Returns value is EnumItem
isEvent
- isEvent(value: unknown): value is Event
-
Parameters
Returns value is Event
isFunction
- isFunction(value: unknown): value is Function
-
Parameters
Returns value is Function
isItem
- isItem(value: unknown): value is Item
-
Parameters
Returns value is Item
isMember
- isMember(value: unknown): value is Member
-
Parameters
Returns value is Member
isMemberBase
- isMemberBase(value: unknown): value is MemberBase<MemberType>
-
Parameters
Returns value is MemberBase<MemberType>
isMemberType
- isMemberType(value: unknown): value is MemberType
-
Parameters
Returns value is MemberType
isParameter
- isParameter(value: unknown): value is Parameter
-
Parameters
Returns value is Parameter
isProperty
- isProperty(value: unknown): value is Property
-
Parameters
Returns value is Property
isPropertySecurity
- isPropertySecurity(value: unknown): value is PropertySecurity
-
Parameters
Returns value is PropertySecurity
isPropertySerialization
- isPropertySerialization(value: unknown): value is PropertySerialization
-
Parameters
Returns value is PropertySerialization
isType
- isType(value: unknown): value is Type
-
Parameters
Returns value is Type
Retrieves the Roblox API dump for the given
version
. If noversion
is supplies,getApiDump
simply retrieves the latest version.