🤖 Merge PR DefinitelyTyped#72557 gulp-flatmap: add type for package by @SamB

Author: SamB

types/gulp-flatmap/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/gulp-flatmap/gulp-flatmap-tests.ts

@@ -0,0 +1,19 @@
+import gulp = require("gulp");
+import flatmap = require("gulp-flatmap");
+import uglify = require("gulp-uglify");
+import path = require("path");
+import concat = require("gulp-concat");
+
+gulp.task("default", function() {
+    return gulp.src("*.json")
+        .pipe(flatmap(function(stream, file) {
+            var contents = JSON.parse(file.contents!.toString("utf8"));
+            // contents.files is an array
+            return gulp.src(contents.files)
+                // uglify each file individually
+                .pipe(uglify())
+                // combine the files
+                .pipe(concat(path.basename(file.path)));
+        }))
+        .pipe(gulp.dest("dist"));
+});

types/gulp-flatmap/index.d.ts

@@ -0,0 +1,20 @@
+import * as File from "vinyl";
+
+export = gulp_flatmap;
+
+/**
+ * @param func
+ *
+ * The flatmap method takes one argument, a function. This function is called once for each file
+ * piped to flatmap and is passed a stream as its first argument and the vinyl file as its second
+ * argument. The stream contains only one file.
+ *
+ * You can now pipe this stream through as many steps as you want, before returning it from the
+ * function. All the streams returned from flatmap will be combined and their contents will be
+ * emited by flatmap.
+ *
+ * @todo Generify if <https://github.com/DefinitelyTyped/DefinitelyTyped/issues/2134> is ever solved
+ */
+declare function gulp_flatmap(
+    func: (stream: NodeJS.ReadableStream, file: File) => NodeJS.ReadableStream,
+): NodeJS.ReadWriteStream;

types/gulp-flatmap/package.json

@@ -0,0 +1,24 @@
+{
+    "private": true,
+    "name": "@types/gulp-flatmap",
+    "version": "1.0.9999",
+    "projects": [
+        "https://github.com/mariusGundersen/gulp-flatmap#readme"
+    ],
+    "devDependencies": {
+        "@types/gulp": "*",
+        "@types/gulp-concat": "*",
+        "@types/gulp-flatmap": "workspace:.",
+        "@types/gulp-uglify": "*"
+    },
+    "dependencies": {
+        "@types/node": "*",
+        "@types/vinyl": "*"
+    },
+    "owners": [
+        {
+            "name": "Samuel Bronson",
+            "githubUsername": "SamB"
+        }
+    ]
+}

types/gulp-flatmap/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "gulp-flatmap-tests.ts"
+    ]
+}