141 lines
3.3 KiB
JSON
141 lines
3.3 KiB
JSON
[
|
|
{
|
|
"namespace": "objects",
|
|
"description": "The objects API.",
|
|
"types": [],
|
|
"functions": [
|
|
{
|
|
"name": "objectParam",
|
|
"type": "function",
|
|
"description": "Takes an object.",
|
|
"parameters": [
|
|
{
|
|
"name": "info",
|
|
"type": "object",
|
|
"properties": {
|
|
"strings": {
|
|
"type": "array",
|
|
"items": {"type": "string"}
|
|
},
|
|
"integer": {
|
|
"type": "integer"
|
|
},
|
|
"boolean": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "callback",
|
|
"type": "function",
|
|
"parameters": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "returnsObject",
|
|
"description": "Returns an object.",
|
|
"type": "function",
|
|
"parameters": [
|
|
{
|
|
"name": "callback",
|
|
"type": "function",
|
|
"parameters": [
|
|
{
|
|
"name": "info",
|
|
"type": "object",
|
|
"properties": {
|
|
"state": {
|
|
"type": "string",
|
|
"enum": ["foo", "bar", "baz"]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "returnsTwoObjects",
|
|
"description": "Return two objects.",
|
|
"type": "function",
|
|
"parameters": [
|
|
{
|
|
"name": "callback",
|
|
"type": "function",
|
|
"parameters": [
|
|
{
|
|
"name": "firstInfo",
|
|
"type": "object",
|
|
"properties": {
|
|
"state": {
|
|
"type": "string",
|
|
"enum": ["foo", "bar", "baz"]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "secondInfo",
|
|
"type": "object",
|
|
"properties": {
|
|
"state": {
|
|
"type": "string",
|
|
"enum": ["spam", "ham", "eggs"]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"events": [
|
|
{
|
|
"name": "onObjectFired",
|
|
"type": "function",
|
|
"description": "Fired when an object is ready.",
|
|
"parameters": [
|
|
{
|
|
"name": "someObject",
|
|
"type": "object",
|
|
"properties": {
|
|
"state": {
|
|
"type": "string",
|
|
"enum": ["foo", "bar", "baz"]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "onTwoObjectsFired",
|
|
"type": "function",
|
|
"description": "Fired when two objects are ready.",
|
|
"parameters": [
|
|
{
|
|
"name": "firstObject",
|
|
"type": "object",
|
|
"properties": {
|
|
"state": {
|
|
"type": "string",
|
|
"enum": ["foo", "bar", "baz"]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "secondObject",
|
|
"type": "object",
|
|
"properties": {
|
|
"state": {
|
|
"type": "string",
|
|
"enum": ["spam", "ham", "eggs"]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
|