@cbortech/cbor 0.26.4 → 0.26.5

package/dist/types.d.ts

@@ -451,6 +451,11 @@ export interface ToCDNOptions {
      * - `number`: number of spaces
      * - `string`: literal indent string (e.g. `'\t'`)
      * - omit for single-line output
+     *
+     * Like `JSON.stringify`, `0` and `''` are equivalent to omitting the
+     * option: the output is a single line. Single-line output is guaranteed
+     * to contain no newlines; layout-dependent options (`preserveComments`,
+     * `splitCdn`, `splitNewline`, `preserveConcatenation`) are ignored.
      */
     indent?: number | string;
     /**
@@ -465,8 +470,9 @@ export interface ToCDNOptions {
      *   kept as-is.
      * - `false` / omitted: strip all comments from the output.
      *
-     * When enabled for containers, comment-bearing arrays/maps are emitted in
-     * multi-line form even if `indent` is omitted.
+     * Only effective when `indent` enables pretty-printing: single-line
+     * output strips all comments, since line comments (`#`, `//`) can only
+     * be terminated by a newline.
      *
      * @default false
      */
@@ -485,6 +491,10 @@ export interface ToCDNOptions {
      * When enabled, this takes precedence over `bstrEncoding` and `sqstr` for
      * byte strings that carry original EDN source text.
      *
+     * In single-line output (no `indent`), an original spelling that spans
+     * multiple lines (e.g. a byte string literal with interior line comments)
+     * falls back to normal serialization; single-line spellings are kept.
+     *
      * @default false
      */
     preserveByteString?: boolean;
@@ -501,6 +511,9 @@ export interface ToCDNOptions {
      * Raw byte string forms (e.g. `` h`...` ``) are covered by
      * `preserveByteString`, not this option.
      *
+     * In single-line output (no `indent`), a spelling that spans multiple
+     * lines falls back to normal escaping; single-line spellings are kept.
+     *
      * @default false
      */
     preserveRawString?: boolean;
@@ -556,7 +569,7 @@ export interface ToCDNOptions {
     floatFormat?: 'decimal' | 'hex';
     /**
      * Split long text strings using CDN string concatenation syntax (`"a" + "b"`).
-     * Only effective when `indent` is specified.
+     * Only effective when `indent` enables pretty-printing.
      *
      * - `'newline'`: split at newline characters
      * - `'cdn'`: split according to CDN structure when the string content
@@ -612,7 +625,8 @@ export interface ToCDNOptions {
      * text strings whose content parses as CDN, while `splitNewline` combines
      * with this option by further splitting the preserved parts at newline
      * characters. Has no effect on values that did not originate from a CDN
-     * concatenation.
+     * concatenation, and only takes effect when `indent` enables
+     * pretty-printing (single-line output joins the parts into one literal).
      *
      * @default false
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cbortech/cbor",
-  "version": "0.26.4",
+  "version": "0.26.5",
   "description": "Convert between CBOR, CDN (CBOR-EDN), and JavaScript values",
   "keywords": [
     "cbor",