Axway Amplify End-of-Life Announcement
👇 See notes below 👇
🪦 RIP Axway Amplify Titanium (2010 - 2022)
🪦 RIP Axway Amplify Cloud Services (2012 - 2022)
🛑 All products affected by the announcements will not be supported by Axway effective their EOL dates in 2022.
Some Open-Source versions of Axway products will live on after End-of-Life (EOL) Axway Amplify product announcements. However, some products are closed-source and will NOT continue after the shut down in 2022.
👉 Stay tuned for more info as plans are being made to save the Titanium project and move it under the control of a independent group of developers.
@titanium/json5
Titanium native mobile module for JSON5 - JSON for Humans. Based on https://github.com/json5/json5
📝 Description
JSON5 – JSON for Humans
The JSON5 Data Interchange Format (JSON5) is a superset of [JSON] that aims to
alleviate some of the limitations of JSON by expanding its syntax to include
some productions from [ECMAScript 5.1].
🚀 Getting Started
Install using npm:
npm install @titanium/json5
Usage
const JSON5 = require('@titanium/json5');
JSON5.parse();
JSON5.stringify();
Short Example
{
unquoted: 'and you can quote me on that',
singleQuotes: 'I can use "double quotes" here',
lineBreaks: "Look, Mom! \
No \\n's!",
hexadecimal: 0xdecaf,
leadingDecimalPoint: .8675309, andTrailing: 8675309.,
positiveSign: +1,
trailingComma: 'in objects', andIn: ['arrays',],
"backwardsCompatible": "with JSON",
}
Features
The following ECMAScript 5.1 features, which are not supported in JSON, have
been extended to JSON5.
Objects
- Object keys may be an ECMAScript 5.1 IdentifierName.
- Objects may have a single trailing comma.
Arrays
- Arrays may have a single trailing comma.
Strings
- Strings may be single quoted.
- Strings may span multiple lines by escaping new line characters.
- Strings may include character escapes.
Numbers
- Numbers may be hexadecimal.
- Numbers may have a leading or trailing decimal point.
- Numbers may be IEEE 754 positive infinity, negative infinity, and NaN.
- Numbers may begin with an explicit plus sign.
- Single and multi-line comments are allowed.
White Space
- Additional white space characters are allowed.
API
The JSON5 API is compatible with the JSON API.
JSON5.parse()
Parses a JSON5 string, constructing the JavaScript value or object described by
the string. An optional reviver function can be provided to perform a
transformation on the resulting object before it is returned.
Syntax
JSON5.parse(text[, reviver])
Parameters
text
: The string to parse as JSON5.reviver
: If a function, this prescribes how the value originally produced by
parsing is transformed, before being returned.
Return value
The object corresponding to the given JSON5 text.
JSON5.stringify()
Converts a JavaScript value to a JSON5 string, optionally replacing values if a
replacer function is specified, or optionally including only the specified
properties if a replacer array is specified.
Syntax
JSON5.stringify(value[, replacer[, space]])
JSON5.stringify(value[, options])
Parameters
value
: The value to convert to a JSON5 string.replacer
: A function that alters the behavior of the stringification
process, or an array of String and Number objects that serve as a whitelist
for selecting/filtering the properties of the value object to be included in
the JSON5 string. If this value is null or not provided, all properties of the
object are included in the resulting JSON5 string.space
: A String or Number object that's used to insert white space into the
output JSON5 string for readability purposes. If this is a Number, it
indicates the number of space characters to use as white space; this number is
capped at 10 (if it is greater, the value is just 10). Values less than 1
indicate that no space should be used. If this is a String, the string (or the
first 10 characters of the string, if it's longer than that) is used as white
space. If this parameter is not provided (or is null), no white space is used.
If white space is used, trailing commas will be used in objects and arrays.options
: An object with the following properties:
replacer
: Same as the replacer
parameter.space
: Same as the space
parameter.quote
: A String representing the quote character to use when serializing
strings.
Return value
A JSON5 string representing the value.
Node.js require()
JSON5 files
When using Node.js, you can require()
JSON5 files by adding the following
statement.
require('json5/lib/register')
Then you can load a JSON5 file with a Node.js require()
statement. For
example:
const config = require('./config.json5')
🔗 Related Links
- Titanium Mobile - Open-source tool for building powerful, cross-platform native apps with JavaScript.
- Alloy - MVC framework built on top of Titanium Mobile.
- Appcelerator - Installer for the Appcelerator Platform tool
- JSON5 - JSON5 Home Page
📚 Learn More
📣 Feedback
Have an idea or a comment? Join in the conversation here!
©️ Legal
License
MIT. See license.md for details.
Credits
Assem Kishore founded this project.
Michael Bolin independently arrived at and published
some of these same ideas with awesome explanations and detail. Recommended
reading: Suggested Improvements to JSON
Douglas Crockford of course designed and built
JSON, but his state machine diagrams on the JSON website, as
cheesy as it may sound, gave us motivation and confidence that building a new
parser to implement these ideas was within reach! The original
implementation of JSON5 was also modeled directly off of Doug’s open-source
json_parse.js parser. We’re grateful for that clean and well-documented
code.
Max Nanasy has been an early and prolific
supporter, contributing multiple patches and ideas.
Andrew Eisenberg contributed the original
stringify
method.
Jordan Tucker has aligned JSON5 more closely
with ES5, wrote the official JSON5 specification, completely rewrote the
codebase from the ground up, and is actively maintaining this project.
Alloy is developed by Appcelerator and the community and is Copyright © 2012-Present by Appcelerator, Inc. All Rights Reserved.
Alloy is made available under the Apache Public License, version 2. See their license file for more information.
Appcelerator is a registered trademark of Appcelerator, Inc. Titanium is a registered trademark of Appcelerator, Inc. Please see the LEGAL information about using trademarks, privacy policy, terms of usage and other legal information at http://www.appcelerator.com/legal.