connect-sdk-client-js
Advanced tools
The JavaScript based client SDK that can be used for client to server communication between you and the Worldline Global Collect platform
The JavaScript SDK helps you to communicate with the Worldline Connect Client API. Its primary features are:
See the Worldline Global Collect Developer Hub for more information on how to use the SDK.
Minimal browser versions:
⚠ Please note that all examples have been moved to their own repository.
Install this SDK using your preferred node package manager npm, yarn, pnpm or Bun.
npm install connect-sdk-client-js
The SDK can be used AS UMD, CJS or ESM module.
The SDK is available under global namespace connectsdk and can be used in the following way:
app.js
const sessionDetails = {
/* ... */
};
// We can access the SDK via the global namespace `window.connectsdk`
const session = new window.connectsdk.Session(sessionDetails);
index.html
<!doctype html>
<html lang="en">
<head>
<title>Example UMD</title>
<script
defer
src="./node_modules/connect-sdk-client-js/dist/connect-sdk-client-js.umd.js"
></script>
<script defer src="./app.js"></script>
</head>
</html>
import { Session, type SessionDetails } from 'connect-sdk-client-js';
const sessionDetails: SessionDetails = {
/* ... */
};
const session = new Session(sessionDetails);
const { Session } = require('connect-sdk-client-js');
/**
* @type {import('connect-sdk-client-js').SessionDetails}
*/
const sessionDetails = {
/* ... */
};
const session = new Session(sessionDetails);
This repository uses microbundle to build the SDK. You can build the sdk by running the following commands:
npm run build
The result of the build will have been written to the dist folder. This folder will contain the following files:
/dist/types - Directory containing all type declaration file. The index.d.ts is set as main file for the exported package, see package.json:types property./dist/connect-sdk-client-js.js - The compiled TypeScript as ESM module. This file will be when using ESM, see package.json:module property./dist/connect-sdk-client-js.umd.js - The compiled TypeScript as UMD module. This file can be used when you want to use the library as UMD, see package.json:unpkg property./dist/connect-sdk-client-js.cjs - The compiled TypeScript as CommonJS module. This file can be used when you want to use the library as CommonJS, see package.json:main property.This library contains unit- and integration tests written with Vitest.
By default Vitest starts in watch mode when starting locally and run mode when running in CI (when environment var CI is set), see documentation.
| Command | Description |
|---|---|
npm run test | Run unit tests |
npm run test:integration | Run integration tests |
FAQs
The JavaScript based client SDK that can be used for client to server communication between you and the Worldline Global Collect platform
The npm package connect-sdk-client-js receives a total of 1,670 weekly downloads. As such, connect-sdk-client-js popularity was classified as popular.
We found that connect-sdk-client-js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.