xAPI.js
GitHubnpm
Search…
xAPI.js
xAPI Wrapper Library
Introduction
Getting Started
The XAPI Class
Statement Resource
State Resource
Activity Profile Resource
Agent Profile Resource
About Resource
Agents Resource
Activities Resource
Helpers
Verbs
Attachment Usages
cmi5 Profile Library
Introduction
Getting Started
The Cmi5 Class
"cmi5 defined" Statement methods
"cmi5 allowed" Statement methods
Helpers
Powered By GitBook
About Resource
Get information about the LRS.

getAbout

Gets information about the LRS.

Example

1
xapi.getAbout().then((result: AxiosResponse<About>) => {
2
const about: About = result.data;
3
console.log(about); // {versions: ["1.0.3"]}
4
});
Copied!

Parameters

Parameter
Type
Required
Description
useCacheBuster
boolean
false
Enables cache busting.

Returns

This method returns an AxiosPromise with the success data containing an About object.
xAPI Wrapper Library - Previous
Agent Profile Resource
Next - xAPI Wrapper Library
Agents Resource
Last modified 1mo ago
Copy link
Contents
getAbout
Example
Parameters
Returns