JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 5
  • Score
    100M100P100Q35696F
  • License Apache-2.0

Kinvey JavaScript SDK Core

Package Exports

  • kinvey-javascript-sdk-core
  • kinvey-javascript-sdk-core/dist/client
  • kinvey-javascript-sdk-core/dist/errors
  • kinvey-javascript-sdk-core/dist/kinvey

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (kinvey-javascript-sdk-core) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Kinvey JavaScript SDK Core

The Kinvey JavaScript SDK core is a package that can be used to develop JavaScript applications on the Kinvey platform. The Kinvey JavaScript SDK core is intended used as a way to share common code across different JS SDK builds.

The Kinvey JS SDK core supports several platforms through platform-specific shims. Here is a list of shims we currently support, each as a separate repo -

Refer to the Kinvey DevCenter for documentation on using Kinvey.

Building

The simplest way to build the sdk is by running gulp. More advanced tasks are available.

  • gulp bump: bump the pacakge version
  • gulp build: build the sdk
  • gulp clean: remove files created by the build process
  • gulp lint: lint src files

Flags

The following flags are available when running gulp bump:

  • --type <major|minor|patch|prerelease>: Bumps the package version using the Semantic Version 2.0.0 spec. Defaults to patch.
  • --version <version>: Sets the package version to the provided version.

Testing

You can run the tests using npm test.

Releasing

The workflow for releasing a new version of the sdk is as follows:

  1. Commit all changes on the develop branch.
  2. Checkout the master branch and merge the develop branch.
  3. Update the Changelog.
  4. Run gulp bump --type <type> replacing <type> with major, minor, patch, or prerelease. See Flags above.
  5. Run gulp.
  6. Make sure all changes are committed on the master branch and push.
  7. Checkout the develop branch and merge the master branch.
  8. Tag the version with git.

Version Management

Updating the sdk version should follow Semantic Version 2.0.0:

  • Major (x.0.0): when making an incompatible API changes.
  • Minor (3.x.0): when adding functionality in a backwards-compatible manner.
  • Patch (3.0.x): when making backwards-compatible bug fixes or enhancements.

License

See LICENSE for details.

Contributing

See CONTRIBUTING.md for details on reporting bugs and making contributions.