@playkit-js/video-ended-marker
v1.0.3
Published
[![Build Status](https://app.travis-ci.com/kaltura/playkit-js-plugin-example.svg?branch=master)](https://app.travis-ci.com/kaltura/playkit-js-plugin-example) [![](https://img.shields.io/npm/v/@playkit-js/plugin-example/latest.svg)](https://www.npmjs.com/p
Downloads
8
Readme
playkit-js-video-ended-marker
playkit-js-video-ended-marker
is a [kaltura player] plugin which logs an arbitrary value to the console.
10
is the default value, you can change it using the textToLog
config of this plugin.
It relies on [kaltura player] core API for managing UI features.
playkit-js-video-ended-marker is written in ECMAScript6 (*.js
) and TypeScript (*.ts
) (strongly typed superset of ES6),
and transpiled in ECMAScript5 using Babel and the TypeScript compiler.
Webpack is used to build the distro bundle and serve the local development environment.
Plugin Config
plugins: {
videoEndedMarker: {
textToLog: '10' // default value is 10.
}
}
Features
Getting started with development
# First, checkout the repository and install the required dependencies
git clone https://github.com/Kaltura-PS/playkit-js-video-ended-marker.git
# Navigate to the repo dir
cd playkit-js-video-ended-marker
# Run dev-server for demo page (recompiles on file-watch, and write to actual dist fs artifacts)
yarn
yarn build
yarn dev
# Before submitting a PR - Run the pre commit command
npm run pre:commit
# this command will run:
# 1. types check
# 2. lint check
# 3. generate/update types
# 4. generate/update docs
The dev server will host files on port 8000. Once started, the demo can be found running at http://localhost:8000/.
Before submitting a PR, please see our contribution guidelines.
Linter (ESlint)
Run linter:
npm run lint:check
Run linter with auto-fix mode:
yarn run lint:fix
Formatting Code
Run prettier to format code
yarn run prettier:fix
Type Check
Run type-check to verify TypeScript types
yarn run types:check
Automated tests (Mocha/Karma)
Run all tests at once:
yarn test
Run unit tests in watch mode:
yarn run test:watch