xAPI.js
  • 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
On this page
  • getAbout
  • Example
  • Parameters
  • Returns

Was this helpful?

  1. xAPI Wrapper Library

About Resource

Get information about the LRS.

PreviousAgent Profile ResourceNextAgents Resource

Last updated 3 years ago

Was this helpful?

getAbout

Gets information about the LRS.

Example

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

Parameters

Parameter

Type

Required

Description

useCacheBuster

boolean

false

Enables cache busting.

Returns

This method returns an AxiosPromise with the success data containing an object.

About