<html>
<head>
<meta charset="utf-8">
<title>JS Bin</title>
<script src="https://npmcdn.com/api-check/dist/api-check.js"></script>
</head>
<body>
<h1>apiCheck.js example</h1>
Check the console... And the code.
</body>
</html>
var myCheck = apiCheck({
output: {
prefix: 'myApp',
suffix: 'see docs -->',
docsBaseUrl: 'http://example.com/error-descriptions#'
}
});
function doSomething(person, options, callback) {
myCheck.warn([ // you can also do myCheck.throw to throw an exception
myCheck.shape({
name: myCheck.shape({
first: myCheck.string,
last: myCheck.string
}),
age: myCheck.number,
isOld: myCheck.bool,
walk: myCheck.func,
ipAddress: function(val, name, location) {
if (!/(\d{1,3}\.){3}\d{1,3}/.test(val)) {
return myCheck.utils.getError(name, location, 'ipAddress');
}
},
childrenNames: myCheck.arrayOf(myCheck.string).optional
}),
myCheck.any.optional,
myCheck.func
], arguments, {
prefix: 'doSomething',
suffix: 'Good luck!',
urlSuffix: 'dosomething-api-check-failure'
});
// do stuff
}
var person = {
name: {
first: 'Matt',
last: 'Meese'
},
age: 27,
isOld: false,
ipAddress: '127.0.0.1',
walk: function() {}
};
function callback() {}
var options = 'whatever I want because it is an "any" type';
console.log('Successful call');
doSomething(person, options, callback);
console.log('Successful call (without options)');
doSomething(person, callback); // <-- options is optional
console.log('Failed call (without person)');
doSomething(callback); // <-- this would fail because person is not optional
person.ipAddress = 'Invalid IP Address!!!';
console.log('Failed call (invalid ip address)');
doSomething(person, options, callback);
Output
You can jump to the latest bin by adding /latest
to your URL
Keyboard Shortcuts
Shortcut | Action |
---|---|
ctrl + [num] | Toggle nth panel |
ctrl + 0 | Close focused panel |
ctrl + enter | Re-render output. If console visible: run JS in console |
Ctrl + l | Clear the console |
ctrl + / | Toggle comment on selected lines |
ctrl + ] | Indents selected lines |
ctrl + [ | Unindents selected lines |
tab | Code complete & Emmet expand |
ctrl + shift + L | Beautify code in active panel |
ctrl + s | Save & lock current Bin from further changes |
ctrl + shift + s | Open the share options |
ctrl + y | Archive Bin |
Complete list of JS Bin shortcuts |
JS Bin URLs
URL | Action |
---|---|
/ | Show the full rendered output. This content will update in real time as it's updated from the /edit url. |
/edit | Edit the current bin |
/watch | Follow a Code Casting session |
/embed | Create an embeddable version of the bin |
/latest | Load the very latest bin (/latest goes in place of the revision) |
/[username]/last | View the last edited bin for this user |
/[username]/last/edit | Edit the last edited bin for this user |
/[username]/last/watch | Follow the Code Casting session for the latest bin for this user |
/quiet | Remove analytics and edit button from rendered output |
.js | Load only the JavaScript for a bin |
.css | Load only the CSS for a bin |
Except for username prefixed urls, the url may start with http://jsbin.com/abc and the url fragments can be added to the url to view it differently. |