ndjson: initial definition (#43073)

types/ndjson/index.d.ts

@@ -0,0 +1,19 @@
+// Type definitions for ndjson 1.5
+// Project: https://github.com/maxogden/ndjson
+// Definitions by: Junxiao Shi <https://github.com/yoursunny>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+/// <reference types="node" />
+
+import { ThroughStream } from "through";
+import { DuplexOptions, Transform } from "stream";
+
+export interface ParseOptions {
+    strict?: boolean;
+}
+
+export function parse(opts?: ParseOptions): ThroughStream;
+
+export function serialize(opts?: DuplexOptions): Transform;
+
+export function stringify(opts?: DuplexOptions): Transform;

types/ndjson/ndjson-tests.ts

@@ -0,0 +1,15 @@
+import * as ndjson from "ndjson";
+import * as fs from "fs";
+
+let parser = ndjson.parse();
+parser = ndjson.parse({ strict: true });
+
+fs.createReadStream("data.txt")
+  .pipe(parser)
+  .on("data", (obj) => undefined);
+
+let serialize = ndjson.serialize();
+serialize = ndjson.stringify({ encoding: "ascii" });
+serialize.on("data", (line) => undefined);
+serialize.write({ foo: "bar" });
+serialize.end();

types/ndjson/tsconfig.json

@@ -0,0 +1,23 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "ndjson-tests.ts"
+    ]
+}

types/ndjson/tslint.json

@@ -0,0 +1 @@
+{ "extends": "dtslint/dt.json" }