Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Pyrodash/libamf
Action Message Format library for node.js.
https://github.com/Pyrodash/libamf
Last synced: 13 days ago
JSON representation
Action Message Format library for node.js.
- Host: GitHub
- URL: https://github.com/Pyrodash/libamf
- Owner: Pyrodash
- License: mit
- Created: 2019-09-20T03:46:30.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T06:30:40.000Z (over 1 year ago)
- Last Synced: 2024-04-25T19:20:38.225Z (about 2 months ago)
- Language: JavaScript
- Size: 109 KB
- Stars: 9
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-stars - Pyrodash/libamf - Action Message Format library for node.js. (JavaScript)
README
# libamf
An Action Message Format library for node.js.
 
## Usage
### Parser/Serializer
```javascript
const libamf = require('libamf');
const data = libamf.serialize(5, libamf.ENCODING.AMF3);
const int = libamf.deserialize(data, libamf.ENCODING.AMF3);
```
### Server
```javascript
const {Server, Service} = require('libamf');
class PizzaService extends Service {
constructor() {
super('pizza');
this.register('order', 'handleOrder');
this.register('cancelOrder', this.cancelOrder.bind(this));
this.register('asyncMethod', 'asyncMethod');
}
handleOrder(pizza, message) {
message.respond({ status: 1, message: pizza.type + ' pizza ordered!'});
}
cancelOrder(pizza, message) {
const id = pizza.id;
return { status: 1, message: 'Order ' + id + ' has been cancelled successfully.'};
}
asyncMethod(message) {
return new Promise((resolve, reject) => {
resolve('this will be sent as a response');
});
}
}
const server = new Server();
// You can also just do this
server.on('data', packet => {
console.log(packet);
});
server.registerService(pizzaService);
server.listen(8080, () => {
console.log('Listening on port 8080');
});
```
You can stop services from enforcing the `-service` suffix to the name by doing:
```javascript
libamf.Service.ForceSuffix = false;
```
You can also allow any service method to be used without registration by doing:
```javascript
libamf.Service.RequireRegistration = false;
```
If you wish to return other values in your service methods, you can disable responding with return values using:
```javascript
libamf.Service.ReturnResponses = false;
```
To write whole numbers as integers, use this:
```javascript
libamf.AMF3.AssumeIntegers = true;
```
To disable the default homepage, use:
```javascript
libamf.Server.DisableDefaultHome = true;
```
### Client
```javascript
const {Client} = require('libamf');
const client = new Client();
client.connect('http://localhost:8080/');
client.call('pizza-service.order', { type: 'cheese' }).then(res => {
console.log(res);
});
```
### SOL
```javascript
const fs = require('fs');
const libamf = require('libamf');
fs.readFile('path/to/file.sol', (err, data) => {
console.log(libamf.SOL.read(data));
const newObj = new libamf.SOL.LSO({
allow: false,
always: false,
allowsecure: false,
alwayssecure: false,
klimit: 100,
hstsEnabled: false,
hstsMaxAge: '0',
hstsIncSubDomain: false,
hstsStartTime: '0'
});
newObj.filename = 'domain/settings';
newObj.version = 0;
console.log(newObj.write());
});
```
## Supported types
### AMF0
|Type|Read|Write|Note|
|--|--|--|--|
|Null|✔|✔|
|Undefined|✔|✔|
|String|✔|✔|
|Long String|✔|✔|
|Number|✔|✔|
|Boolean|✔|✔|
|Reference|✔|✔|
|Strict Array|✔|✔|
|ECMA Array|✔|✔|
|Typed Object|✔|✔|
|Date|✔|✔|
|AVMPLUS|✔|✔|
|XML|✔|✔|
### AMF3
|Type|Read|Write|Note|
|--|--|--|--|
|Undefined|✔|✔|
|Null|✔|✔|
|String|✔|✔|
|Double|✔|✔|
|Integer|✔|✔|
|Boolean|✔|✔|
|Date|✔|✔|
|Array|✔|✔|
|Dictionary|✔|✔|
|Vector|✔|✔|
|Byte Array|✔|✔|
|Custom object|✔|✔|
|XML|✔|✔|
## TODO
- Better documentation
- Better tests
- Better TODO