LRS types

Description

LRS shared types library.

The LRS type definitions library were inspired by the xAPI specs. Below some refs to the specs:

• xAPI-spec
• xAPI-About Experience API
• xAPI-Experience API data
• xAPI-Experience API protocol

💻 Dev info(s)

👇 The tsconfig.json file in the root of the package will create type definition files in the dist directory.

{
    "compilerOptions": {
        "declaration": true,
        "declarationDir": "dist-types",
        "outDir": "dist-types"
    },
    "include": [
        "types",
        "main.ts"
    ],
    "exclude": [
        "node_modules",
    ]
}

👇 The build script defined in package.json required to to compile TypeScript code

{
  "scripts": {
      "prebuild": "rm -rf dist-types",
      "build": "tsc",
      "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
      "test": "echo  \"Error: no test specified\" && exit 1"
  },
}

🚀 Deploy info(s)

👇 Generate type definitions with:

yarn prebuild && yarn build