Skip to content

michalstocki/scorm-api-wrapper-ts

 
 

Repository files navigation

SAW

Code Climate Test Coverage Build Status

Introduction

Saw is an Object Oriented SCORM API Wrapper for SCORM 1.2

Why

This library allows you to develop a fully testable SCO engine.

SCORM Documentation

The SCORM 1.2 Run Time Environement specification can be found in the docs/ folder of the project

Usage

Installation

with npm

npm install scorm-api-wrapper --save

Initialization and usage

var saw = require('scorm-api-wrapper');

/* Initialize the API wrapper and establish connection to the LMS*/
saw.initialize();

/* Set a value of the SCORM Data Model*/
saw.setScormValue('cmi.core.score', 85 );

/* Get a value of the SCORM Data Model*/
var value = saw.getScormValue('cmi.core.score');

/* Persist current state of the Data Model (i.e. LMSCommit() )*/
saw.commit();

/* Persist the Data Model and close the connection to the LMS*/
saw.finish();

Development

  • Fork the project
  • Clone the project to your machine
  • Install nodejs
  • Install the dependencies with npm install
  • Run test npm test
  • You're ready!

About

Saw is a SCORM API Wrapper in TypeScript

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 70.8%
  • TypeScript 29.2%