What is ssf?
The ssf npm package is a format library for handling spreadsheet string formats. It allows users to format numbers and dates in a way that is consistent with spreadsheet software like Microsoft Excel or Google Sheets. This can be particularly useful for applications that deal with data export, reporting, or any form of data presentation that requires spreadsheet-like formatting.
What are ssf's main functionalities?
Number Formatting
This feature allows you to format numbers according to a specified format string. In this example, a number is formatted to two decimal places.
"SSF.format('0.00', 123.456); // '123.46'"
Date Formatting
This feature enables the formatting of JavaScript Date objects into a string format based on the provided format string. Here, a date is formatted into a YYYY-MM-DD format.
"SSF.format('YYYY-MM-DD', new Date(2023, 3, 1)); // '2023-04-01'"
Custom Formats
SSF allows for the creation of custom formats to handle specific formatting needs. This example demonstrates how to format numbers into a 'Million' or 'Thousand' string based on their value.
"SSF.format('[>999999]#,##0,"Million";#,##0,"Thousand"', 1200000); // '1,200,000,"Million"'"
Other packages similar to ssf
numbro
Numbro is a robust formatting library for numbers. It offers extensive options for number formatting, including currency, percentages, and time spans. While it provides similar number formatting capabilities, it lacks the direct spreadsheet-style formatting and date handling that ssf offers.
date-fns
date-fns provides a comprehensive toolkit for date manipulation and formatting. It excels in handling dates and times, offering a wide range of functions for these purposes. Unlike ssf, date-fns focuses exclusively on dates and does not cover number formatting.
accounting
The accounting package is focused on formatting numbers for financial contexts, offering functions for currency formatting, precision rounding, and number formatting. While it shares the number formatting aspect with ssf, it is more narrowly focused on financial applications and does not include date formatting capabilities.
ssf (SpreadSheet Format) is a pure JS library to format data using ECMA-376
spreadsheet format codes (used in popular spreadsheet software packages).
This is the community version. We also offer a pro version with additional
features like international support as well as dedicated support.
Installation
With npm:
$ npm install ssf
In the browser:
<script src="ssf.js"></script>
The browser exposes a variable SSF
When installed globally, npm installs a script ssf
that renders the format
string with the given arguments. Running the script with -h
displays help.
The script will manipulate module.exports
if available . This is not always
desirable. To prevent the behavior, define DO_NOT_EXPORT_SSF
.
Usage
SSF.format(fmt, val, opts)
formats val
using the format fmt
.
If fmt
is a string, it will be parsed and evaluated. If fmt
is a number
,
the actual format will be the corresponding entry in the internal format table.
For a raw numeric format like 000
, the value should be passed as a string.
Date arguments are interpreted in the local time of the JS client.
The options argument may contain the following keys:
Option Name | Default | Description |
---|
date1904 | false | Use 1904 date system if true, 1900 system if false |
Manipulating the Internal Format Table
Binary spreadsheet formats store cell formats in a table and reference by index.
This library uses a global table:
SSF._table
is the underlying object, mapping numeric keys to format strings.
SSF.load(fmt:string, idx:?number):number
assigns the format to the specified
index and returns the index. If the index is not specified, SSF will search the
space for an available format slot pick an unused slot. For compatibility with
the XLS and XLSB file formats, custom indices should be in the valid ranges
5-8
, 23-26
, 41-44
, 63-66
, 164-382
(see [MS-XLSB] 2.4.655 BrtFmt
)
SSF.get_table()
gets the internal format table (number to format mapping).
SSF.load_table(table)
sets the internal format table.
Other Utilities
SSF.parse_date_code(val:number, opts:?any)
parses val
, returning an object:
type SSFDate = {
D:number;
y:number;
m:number;
d:number;
q:number;
T:number;
H:number;
M:number;
S:number;
u:number;
}
SSF.is_date(fmt:string):boolean
returns true
if fmt
encodes a date format.
Examples
License
Please consult the attached LICENSE file for details. All rights not explicitly
granted by the Apache 2.0 license are reserved by the Original Author.
References
ECMA-376
: Office Open XML File FormatsMS-XLS
: Excel Binary File Format (.xls) Structure SpecificationMS-XLSB
: Excel (.xlsb) Binary File Format
Badges