Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/serverless/fdk
This library is deprecated. Please use https://github.com/serverless/event-gateway-sdk instead.
https://github.com/serverless/fdk
serverless serverless-framework stdlib
Last synced: about 2 months ago
JSON representation
This library is deprecated. Please use https://github.com/serverless/event-gateway-sdk instead.
- Host: GitHub
- URL: https://github.com/serverless/fdk
- Owner: serverless
- License: mit
- Created: 2016-11-03T13:43:27.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T17:28:49.000Z (about 2 years ago)
- Last Synced: 2024-11-02T12:35:05.680Z (3 months ago)
- Topics: serverless, serverless-framework, stdlib
- Language: JavaScript
- Homepage:
- Size: 33.2 MB
- Stars: 69
- Watchers: 29
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
**IMPORTANT**: This library is deprecated. Please use https://github.com/serverless/event-gateway-sdk instead.
# Function Development Kit (aka FDK)
Node.js library to improve developer experience developing Serverless applications.
It contains a client to configure and interact with the [Event Gateway](https://github.com/serverless/event-gateway).
[](https://travis-ci.org/serverless/fdk)
## Install (Node)
```bash
npm install @serverless/fdk
```
## Install (Browser)
```html
```
The FDK then will be attached to window e.g. and you can access it via `window.fdk`
## Create an Event Gateway Client
```js
const fdk = require('@serverless/fdk');
const eventGateway = fdk.eventGateway({
url: 'http://localhost',
})
```
Optional Properties for `eventGateway`
```js
{
// defaults to the provide URL + default config port 4001
configurationUrl: 'http://localhost:4001'
// optional property to provide their own http lib
fetchClient: fetch
}
```
## Invoke a Function
```js
eventGateway.invoke({
functionId: "createUser",
data: { name: "Max" },
})
```
Returns a Promise with the response.
The value of data is converted using `JSON.stringify` by default since the default dataType is `application/json`. This is not happening and the value is passed as it is when the property `dataType` is provided.
### Invoke a Function with a Custom Data Type
```js
eventGateway.invoke({
functionId: "createUser",
data: "Max",
dataType: "text/plain",
})
```
## Emit an Event
```js
eventGateway.emit({
event: "userCreated",
data: { name: "Max" },
})
```
Returns a Promise and when resolved the response only indicates if the Event Gateway received the event. Responses from any subscribed functions are not part of the response.
The value of data is converted using `JSON.stringify` by default since the default dataType is `application/json`. This is not happening and the value is passed as it is when the property `dataType` is provided.
### Emit an Event with a Custom Data Type
```js
eventGateway.emit({
event: "userCreated",
data: "This is a string message.",
dataType: "text/plain",
})
```
## Configure an Event Gateway
Configure accepts an object of function and subscription definitions. The idea of exposing one configuration function is to provide developers with convenient utility to configure an Event Gateway in one call rather then dealing with a chain of Promise based calls. Nevertheless in addition we expose a wrapper function for each low-level API call to the Event Gateway described in this [section](#further-event-gateway-functions).
```js
eventGateway.configure({
// list of all the functions that should be registered
functions: [
{
functionId: "helloWorld"
provider: {
type: "awslambda"
arn: "xxx",
region: "us-west-2",
}
},
{
functionId: "sendWelcomeMail"
provider: {
type: "gcloudfunction"
name: "sendWelcomeEmail",
region: "us-west-2",
}
}
],
// list of all the subscriptions that should be created
subscriptions: [
{
event: "http",
method: "GET",
path: "/users",
functionId: "helloWorld"
},
{
event: "user.created",
functionId: "sendEmail"
}
]
})
```
Returns a promise which contains all the same list of functions and subscriptions in the same structure and order as provided in the configuration argument.
```js
eventGateway.configure({ config })
.then((response) => {
console.log(response)
// {
// functions: [
// { functionId: 'xxx', … },
// { functionId: 'xxx', … }
// ],
// subscriptions: [
// { subscriptionId: 'xxx', … },
// { subscriptionId: 'xxx', … }
// ]
// }
})
```
## Reset the configuration
Reset removes all the existing subscriptions and functions.
```js
eventGateway.resetConfiguration()
```
## Further Event Gateway Functions
```js
// Returns a function
eventGateway.registerFunction({
functionId: "sendEmail"
provider: {
type: "awslambda"
arn: "xxx",
region: "us-west-2",
}
})
// Returns undefined
eventGateway.deleteFunction({ functionId: "sendEmail" })
// Returns an Array of functions
eventGateway.listFunctions()
// Returns a subscription: { subscriptionId, event, functionId}
eventGateway.subscribe({
event: "user.created",
functionId: "sendEmail"
})
// Returns undefined
eventGateway.unsubscribe({
subscriptionId: "user.created-sendEmail"
})
// Returns an Array of subscriptions
eventGateway.listSubscriptions()
```
## Contribute
If you are interested to contribute we recommend to check out the [Contributing](https://github.com/serverless/fdk/blob/master/CONTRIBUTING.md) document as it explains how to get started and some of the design decisions for this library.