AMF3-TS
Fast AMF3 library written in pure Typescript with 0 dependencies, supporting TS, Node and the browser.
Installation
npm i amf3-ts
Type compatibility table
Type |
Serialize |
Deserialize |
Reason for exclusion |
Undefined |
✔️ |
✔️ |
- |
Null |
✔️ |
✔️ |
- |
False |
✔️ |
✔️ |
- |
True |
✔️ |
✔️ |
- |
Integer |
✔️ |
✔️ |
- |
Double |
✔️ |
✔️ |
- |
String |
✔️ |
✔️ |
- |
XML Document |
❌ |
❌ |
Who uses XML? |
Date |
✔️ |
✔️ |
- |
Array |
✔️ |
✔️ |
- |
Object |
✔️ |
✔️ |
- |
XML |
❌ |
❌ |
Who uses XML? |
ByteArray |
✔️ |
✔️ |
- |
Vector int |
✔️ |
✔️ |
- |
Vector uint |
✔️ |
✔️ |
- |
Vector double |
✔️ |
✔️ |
- |
Set |
✔️ |
✔️ |
- |
Map |
✔️ |
✔️ |
- |
Extra compatibility table
Name |
Supported |
Class alias |
✔️ |
Dynamic property writer |
✔️ |
Externalizable classes |
✔️ |
Usage
Below you'll find simple usage examples.
Basic types
Working with basic types is very self explanatory.
Typescript
import { AMF3, ECMAArray } from 'amf3-ts';
const obj: object = { id: 1 };
const ref: object = { ref1: obj, ref2: obj };
const mixed: ECMAArray = Object.assign([], [1,2,3], { 'Key': 'Value' });
const arr: ECMAArray = [1,2,3];
AMF3.parse(AMF3.stringify(obj));
AMF3.parse(AMF3.stringify(ref));
AMF3.parse(AMF3.stringify(mixed));
AMF3.parse(AMF3.stringify(arr));
Node
const { AMF3 } = require('amf3-ts');
const obj = { id: 1 };
const ref = { ref1: obj, ref2: obj };
const mixed = Object.assign([], [1,2,3], { 'Key': 'Value' })
const arr = [1,2,3];
AMF3.parse(AMF3.stringify(obj));
AMF3.parse(AMF3.stringify(ref));
AMF3.parse(AMF3.stringify(mixed));
AMF3.parse(AMF3.stringify(arr));
Browser
<script src="https://cdn.jsdelivr.net/npm/amf3-ts@latest/browser/AMF3.js"></script>
<script>
const obj = { id: 1 };
const ref = { ref1: obj, ref2: obj };
const mixed = Object.assign([], [1,2,3], { 'Key': 'Value' })
const arr = [1,2,3];
AMF3.parse(AMF3.stringify(obj));
AMF3.parse(AMF3.stringify(ref));
AMF3.parse(AMF3.stringify(mixed));
AMF3.parse(AMF3.stringify(arr));
</script>
Changes
This library has a few changes:
- Vector has been changed to
typed arrays
- Vector object has been changed to
Set
- Dictionary has been changed to
Map
- ByteArray has been changed to
Stream
- You can freeze Vector arrays using
Object.preventExtensions
Typescript
import { AMF3, Stream } from 'amf3-ts';
const map: Map<string | number, any> = new Map([[1, 'Value']]);
const set: Set<any> = new Set([1, 'A', 2, 'B', 3, 'C']);
const vectorInt:Int32Array = new Int32Array([1,2,3]);
const fixedVectorUint:Uint32Array = new Uint32Array([1,2,3]);
const stream:Stream = new Stream();
stream.writeUTF('AMF3-TS');
Object.preventExtensions(fixedVectorUint);
AMF3.parse(AMF3.stringify(map));
AMF3.parse(AMF3.stringify(set));
AMF3.parse(AMF3.stringify(vectorInt));
AMF3.parse(AMF3.stringify(fixedVectorUint));
AMF3.parse(AMF3.stringify(stream));
Node
const { AMF3, Stream } = require('amf3-ts');
const map = new Map([[1, 'Value']]);
const set = new Set([1, 'A', 2, 'B', 3, 'C']);
const vectorInt = new Int32Array([1,2,3]);
const fixedVectorUint = new Uint32Array([1,2,3]);
const stream = new Stream();
stream.writeUTF('AMF3-TS');
Object.preventExtensions(fixedVectorUint);
AMF3.parse(AMF3.stringify(map));
AMF3.parse(AMF3.stringify(set));
AMF3.parse(AMF3.stringify(vectorInt));
AMF3.parse(AMF3.stringify(fixedVectorUint));
AMF3.parse(AMF3.stringify(stream));
Browser
<script src="https://cdn.jsdelivr.net/npm/amf3-ts@latest/browser/AMF3.js"></script>
<script>
const map = new Map([[1, 'Value']]);
const set = new Set([1, 'A', 2, 'B', 3, 'C']);
const vectorInt = new Int32Array([1,2,3]);
const fixedVectorUint = new Uint32Array([1,2,3]);
Object.preventExtensions(fixedVectorUint);
AMF3.parse(AMF3.stringify(map));
AMF3.parse(AMF3.stringify(set));
AMF3.parse(AMF3.stringify(vectorInt));
AMF3.parse(AMF3.stringify(fixedVectorUint));
</script>
Typed class
This library also supports typed classes.
Typescript
import { AMF3 } from 'amf3-ts';
class Person {
public name:string;
public age:number;
constructor(name:string, age:number) {
this.name = name;
this.age = age;
}
}
AMF3.registerClassAlias('com.person', Person);
AMF3.isRegisteredClassAlias(Person);
const person: Person = new Person('Daan', 18);
AMF3.parse(AMF3.stringify(person));
AMF3.deregisterClassAlias(Person);
Node
const { AMF3 } = require('amf3-ts');
class Person {
constructor(name, age) {
this.name = name;
this.age = age;
}
}
AMF3.registerClassAlias('com.person', Person);
AMF3.isRegisteredClassAlias(Person);
const person = new Person('Daan', 18);
AMF3.parse(AMF3.stringify(person));
AMF3.deregisterClassAlias(Person);
Browser
<script src="https://cdn.jsdelivr.net/npm/amf3-ts@latest/browser/AMF3.js"></script>
<script>
class Person {
constructor(name, age) {
this.name = name;
this.age = age;
}
}
AMF3.registerClassAlias('com.person', Person);
AMF3.isRegisteredClassAlias(Person);
const person = new Person('Daan', 18);
AMF3.parse(AMF3.stringify(person));
AMF3.deregisterClassAlias(Person);
</script>
Externalizable class
This library also supports externalizable classes.
Typescript
import { AMF3, IExternalizable, IDataInput, IDataOutput } from 'amf3-ts';
class Character implements IExternalizable {
public username: string;
public password: string;
constructor(username: string, password: string) {
this.username = username;
this.password = password;
}
public writeExternal(output: IDataOutput): void {
output.writeUTF(this.username);
output.writeUTF(this.password);
}
public readExternal(input: IDataInput): void {
this.username = input.readUTF();
this.password = input.readUTF();
}
}
AMF3.registerClassAlias('src.Character', Character);
AMF3.parse(AMF3.stringify(new Character('Zaseth', '123123')));
Node
const { AMF3 } = require('amf3-ts');
class Character {
constructor(username, password) {
this.username = username;
this.password = password;
}
writeExternal(output) {
output.writeUTF(this.username);
output.writeUTF(this.password);
}
readExternal(input) {
this.username = input.readUTF();
this.password = input.readUTF();
}
}
AMF3.registerClassAlias('src.Character', Character);
AMF3.parse(AMF3.stringify(new Character('Zaseth', '123123')));
Browser
<script src="https://cdn.jsdelivr.net/npm/amf3-ts@latest/browser/AMF3.js"></script>
<script>
class Character {
constructor(username, password) {
this.username = username;
this.password = password;
}
writeExternal(output) {
output.writeUTF(this.username);
output.writeUTF(this.password);
}
readExternal(input) {
this.username = input.readUTF();
this.password = input.readUTF();
}
}
AMF3.registerClassAlias('src.Character', Character);
AMF3.parse(AMF3.stringify(new Character('Zaseth', '123123')));
</script>
Dynamic property writer
This library also supports Dynamic property writers.
Typescript
import { AMF3, IDynamicPropertyWriter, IDynamicPropertyOutput } from 'amf3-ts';
class HideSensitive implements IDynamicPropertyWriter {
constructor() { }
public writeDynamicProperties(obj: object, output: IDynamicPropertyOutput): void {
for (const prop in obj) {
if (prop.toLowerCase() !== 'password') {
output.writeDynamicProperty(prop, obj[prop]);
}
}
}
}
AMF3.setDynamicPropertyWriter(new HideSensitive());
AMF3.hasDynamicPropertyWriter();
AMF3.parse(AMF3.stringify({ id: 1, username: 'Zaseth', password: '123123' }));
AMF3.setDynamicPropertyWriter(null);
AMF3.hasDynamicPropertyWriter();
Node
const { AMF3 } = require('amf3-ts');
class HideSensitive {
constructor() { }
writeDynamicProperties(obj, output) {
for (const prop in obj) {
if (prop.toLowerCase() !== 'password') {
output.writeDynamicProperty(prop, obj[prop]);
}
}
}
}
AMF3.setDynamicPropertyWriter(new HideSensitive());
AMF3.hasDynamicPropertyWriter();
AMF3.parse(AMF3.stringify({ id: 1, username: 'Zaseth', password: '123123' }));
AMF3.setDynamicPropertyWriter(null);
AMF3.hasDynamicPropertyWriter();
Browser
<script src="https://cdn.jsdelivr.net/npm/amf3-ts@latest/browser/AMF3.js"></script>
<script>
class HideSensitive {
constructor() { }
writeDynamicProperties(obj, output) {
for (const prop in obj) {
if (prop.toLowerCase() !== 'password') {
output.writeDynamicProperty(prop, obj[prop]);
}
}
}
}
AMF3.setDynamicPropertyWriter(new HideSensitive());
AMF3.hasDynamicPropertyWriter();
AMF3.parse(AMF3.stringify({ id: 1, username: 'Zaseth', password: '123123' }));
AMF3.setDynamicPropertyWriter(null);
AMF3.hasDynamicPropertyWriter();
</script>