0.11.2 • Published 1 year ago

@capeprivacy/cape-sdk v0.11.2

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

@capeprivacy/cape-sdk

codecov build

The Cape SDK for JavaScript is a library that provides a simple way to interact with the Cape Privacy API. Works in Node.js and the browser.

Installation

Using npm:

npm install @capeprivacy/cape-sdk

Using yarn:

yarn add @capeprivacy/cape-sdk

Usage

Replace <AUTH_TOKEN> and <FUNCTION_ID> with your values.

run

Run is used to invoke a function once with a single input.

Example run.mjs:

import { Cape } from '@capeprivacy/cape-sdk';

const client = new Cape({ authToken: '<AUTH_TOKEN>' });
await client.run({ id: '<FUNCTION_ID>', data: 'my-data' });

invoke

Invoke is used to run a function repeatedly with a multiple inputs. It gives you more control over the lifecycle of the function invocation.

Example invoke.mjs:

const client = new Cape({ authToken: '<AUTH_TOKEN>' });

try {
  await client.connect({ id: '<FUNCTION_ID>' });

  const results = await Promise.all([
    client.invoke({ data: 'my-data-1' }),
    client.invoke({ data: 'my-data-2' }),
    client.invoke({ data: 'my-data-3' }),
  ]);
  console.log('Cape run result:', results);
} catch (err) {
  console.error('Something went wrong.', err);
} finally {
  client.disconnect();
}

TypeScript

The Cape SDK for JavaScript bundles TypeScript definitions to use in TypeScript projects.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Read more about how to contribute to the Cape SDK in CONTRIBUTING.

License

MIT

0.11.2

1 year ago

0.11.1

1 year ago

0.7.6

1 year ago

0.7.5

1 year ago

0.11.0

1 year ago

0.10.1

1 year ago

0.10.0

1 year ago

0.9.0

1 year ago

0.8.0

1 year ago

0.7.4

1 year ago

0.7.4-alpha.0

1 year ago

0.7.2

1 year ago

0.7.3

1 year ago

0.7.1

2 years ago

0.7.0

2 years ago

0.5.0

2 years ago

0.4.1

2 years ago

0.4.0

2 years ago

0.6.1

2 years ago

0.5.2

2 years ago

0.6.0

2 years ago

0.5.1

2 years ago

0.4.2

2 years ago

0.3.0

2 years ago

0.2.1

2 years ago

0.2.0

2 years ago

0.1.1

2 years ago

0.1.0

2 years ago

0.0.5-next.0

2 years ago

0.0.4

2 years ago

0.0.3

2 years ago