kaltura-typescript-client

Kaltura Typescript client

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
kaltura-typescript-client
3226.0.06 years ago6 years agoMinified + gzip package size for kaltura-typescript-client in KB

Readme

Kaltura Typescript Client
Conventional Commits Gitter chat npm version
An easy-to-use facade to Kaltura server with typescript support for action requests, classes and enums.

This library uses Typescript files that are transpiled into ECMAScript 5 using commonjs as a module system.
This library have zero dependencies at runtime and it can be used in any Javascript project. Those who are using Typescript will benefit even more.
>Visit our live demonstration for code snippets and common use cases.

Installation

use 'npm' to get the library
$ npm install kaltura-typescript-client

Instructions

Getting Started

To keep being update review the changelog frequently.
Have a question? Ask us on Gitter.
Found a bug? create github issue

Features list

View list of features here.
Building the sources
This library is auto-generated using kaltura/clients-generator php engine. Feel free to clone, build and play with this library but in order to submit PR you should work against the kaltura/clients-generator repo.

Building the client library

After cloning the repo you should install dependent libraries:
$ npm install
$ npm run build

Running integration tests

  • In src/tests folder you should duplicate file tests-config.tpl.ts and name it tests-config.ts.
  • Modify the file content to include valid information.
  • Run npm run test to test the library

If you want to test the library against the production server use the following as the endpoint in the config file: http://www.kaltura.com/apiv3/index.php/

License and Copyright Information

All code in this project is released under the AGPLv3 license unless a different license for a particular library is specified in the applicable library path.
Copyright © Kaltura Inc. All rights reserved.