Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
json-transport
Advanced tools
Readme
JSONTransport is the default transport for ApiServer. JSONTransport is the true power of ApiServer. It allows you to provide a JSONP API consumable by a browser both with POST and GET HTTP methods.
Multiple output wrappers are available:
application/json
text/javascript
text/html
The transports auto select the right wrapper based on the callback parameter presence (querystring) and the HTTP method.
For example:
GET http://localhost/1/test/test
will response in JSON format
GET http://localhost/1/test/test?callback=cb
will response in JSONP format
POST http://localhost/1/test/test
will response in JSON format
POST http://localhost/1/test/test?callback=cb
will response in JSONP + iFrame format
new JSONTransport([options])
String
|Boolean
: defaults to 3 spaces) the string used to format your json output or false
to avoid the indentationString
: defaults to '.default.lan') the first level domain where your API will be consumed. (???)new JSONTransport({
indent: ' ',
domain: '.example.com'
})
new ApiServer({
port: 80,
timeout: 2000,
indent: false, // passed to JSONTransport
domain: '.example.com' // passed to JSONTransport
})
The following methods are attached to the response:
This method writes data back to the client and closes the response.
response.serveJSON([data], [options])
Object
) the data to send back to the clientObject
)
Object
) a headers list that will eventually override the default onesNumber
: defaults to 200)String
: defaults to '')// decontextualized API method
function (request, response) {
response.serveJSON({ foo: 'bar' })
})
// decontextualized API method
function (request, response) {
response.serveJSON(['foo','bar', ...], {
httpStatusCode: 404,
httpStatusMessage: 'maybe.. you\'re lost',
headers: {
'x-value': 'foo'
}
})
})
The streamJSON is absolutely another killer feature. It allows you to stream JSON objects to the browser as soon as they are available to you, for example as soon as the MongoDb CursorStream emits the data
event. This means that we are keeping in memory only one object at time and consequently, saving memory.
N.B. the browser still needs to wait the entire response to consume it.
response.streamJSON([data], [options])
Object
) the data to send back to the clientObject
)
Object
) a headers list that will eventually override the default onesNumber
: defaults to 200)String
: defaults to '')To close the response you must call streamJSON
once without arguments. JSONTransport will understand that this is the end of the streaming.
// decontextualized API method
function (request, response) {
var count = 3
var interval = setInterval(function () {
if (count === 0) {
clearInterval(interval)
response.streamJSON()
} else {
count--
response.streamJSON({ foo: 'bar' })
}
}, 200)
})
yields
[
{ "foo": "bar" },
{ "foo": "bar" },
{ "foo": "bar" }
]
This repository follows (more or less) the Felix's Node.js Style Guide, your contribution must be consistent with this style.
The test suite is written on top of visionmedia/mocha and it took hours of hard work. Please use the tests to check if your contribution is breaking some part of the library and add new tests for each new feature.
⚡ npm test
and for your test coverage
⚡ make test-cov
This software is released under the MIT license cited below.
Copyright (c) 2010 Kilian Ciuffolo, me@nailik.org. All Rights Reserved.
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the 'Software'), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
FAQs
JSON transport with streaming and JSONP GET/POST support
The npm package json-transport receives a total of 6 weekly downloads. As such, json-transport popularity was classified as not popular.
We found that json-transport demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.