Use less ambiguous name for form data encoder class and its exports. Keep Encoder as and alias to FormDataEncoder for backward compatibility.

Author: octet-stream

lib/Encoder.test.ts

@@ -10,32 +10,32 @@ import readStream from "./__helper__/readStream"
 import skip from "./__helper__/skipIterations"
 import readLine from "./__helper__/readLine"
 
-import {Encoder} from "./Encoder"
+import {FormDataEncoder} from "./Encoder"
 
 test("Has boundary string", t => {
-  const encoder = new Encoder(new FormData())
+  const encoder = new FormDataEncoder(new FormData())
 
   t.true(typeof encoder.boundary === "string")
 })
 
 test("Accepts custom boundary as the second argument", t => {
   const expected = "BoundaryString123"
 
-  const encoder = new Encoder(new FormData(), expected)
+  const encoder = new FormDataEncoder(new FormData(), expected)
 
   t.is(encoder.boundary, `form-data-boundary-${expected}`)
 })
 
 test("Has content-type string", t => {
-  const encoder = new Encoder(new FormData())
+  const encoder = new FormDataEncoder(new FormData())
 
   t.true(encoder.contentType.startsWith("multipart/form-data; boundary="))
 })
 
 test("Has content-type string with custom boundary string", t => {
   const expected = "BoundaryString123"
 
-  const encoder = new Encoder(new FormData(), expected)
+  const encoder = new FormDataEncoder(new FormData(), expected)
 
   t.is(
     encoder.contentType,
@@ -44,7 +44,7 @@ test("Has content-type string with custom boundary string", t => {
 })
 
 test("Has correct headers", async t => {
-  const encoder = new Encoder(new FormData())
+  const encoder = new FormDataEncoder(new FormData())
 
   t.deepEqual(encoder.headers, {
     "Content-Type": `multipart/form-data; boundary=${encoder.boundary}`,
@@ -53,7 +53,7 @@ test("Has correct headers", async t => {
 })
 
 test("Yields correct footer for empty FormData", async t => {
-  const encoder = new Encoder(new FormData())
+  const encoder = new FormDataEncoder(new FormData())
 
   const iterable = readLine(Readable.from(encoder))
 
@@ -63,13 +63,13 @@ test("Yields correct footer for empty FormData", async t => {
 })
 
 test("The footer ends with two crlf", async t => {
-  const actual = await readStream(new Encoder(new FormData()), true)
+  const actual = await readStream(new FormDataEncoder(new FormData()), true)
 
   t.true(actual.endsWith("\r\n\r\n"))
 })
 
 test("Returns correct length of the empty FormData content", async t => {
-  const encoder = new Encoder(new FormData())
+  const encoder = new FormDataEncoder(new FormData())
   const expected = await readStream(encoder).then(({length}) => length)
 
   t.is<number>(encoder.getContentLength(), expected)
@@ -81,7 +81,7 @@ test("Returns the length of the FormData content", async t => {
   fd.set("field", "Some string")
   fd.set("file", new File(["Some content"], "file.txt"))
 
-  const encoder = new Encoder(fd)
+  const encoder = new FormDataEncoder(fd)
 
   const expected = await readStream(encoder).then(({length}) => length)
 
@@ -93,7 +93,7 @@ test(".values() yields headers as Uint8Array", t => {
 
   fd.set("field", "Some value")
 
-  const iterable = new Encoder(fd).values()
+  const iterable = new FormDataEncoder(fd).values()
 
   const {value: actual} = skipSync(iterable)
 
@@ -105,7 +105,7 @@ test(".valeus() yields field as Uint8Array", t => {
 
   fd.set("field", "Some value")
 
-  const {value: actual} = skipSync(new Encoder(fd).values(), 2)
+  const {value: actual} = skipSync(new FormDataEncoder(fd).values(), 2)
 
   t.true(actual instanceof Uint8Array)
 })
@@ -118,7 +118,7 @@ test(".valeus() yields field's content", t => {
 
   fd.set("field", string)
 
-  const {value: actual} = skipSync(new Encoder(fd).values(), 2)
+  const {value: actual} = skipSync(new FormDataEncoder(fd).values(), 2)
 
   t.true(Buffer.from(actual as Uint8Array).equals(expected))
 })
@@ -130,7 +130,7 @@ test(".values() yields a file as is", async t => {
 
   fd.set("file", file)
 
-  const {value: actual} = skipSync(new Encoder(fd).values(), 2)
+  const {value: actual} = skipSync(new FormDataEncoder(fd).values(), 2)
 
   t.true(actual instanceof File)
   t.is(await (actual as File).text(), await file.text())
@@ -141,7 +141,7 @@ test("Yields correct headers for a field", async t => {
 
   fd.set("field", "Some value")
 
-  const iterable = readLine(Readable.from(new Encoder(fd)))
+  const iterable = readLine(Readable.from(new FormDataEncoder(fd)))
 
   const {value} = await skip(iterable, 2)
 
@@ -155,7 +155,9 @@ test("Yields field's content", async t => {
 
   fd.set("field", expected)
 
-  const {value} = await skip(readLine(Readable.from(new Encoder(fd))), 4)
+  const {
+    value
+  } = await skip(readLine(Readable.from(new FormDataEncoder(fd))), 4)
 
   t.is(value, expected)
 })
@@ -165,7 +167,9 @@ test("Yields Content-Disposition header for a File", async t => {
 
   fd.set("file", new File(["My hovercraft is full of eels"], "file.txt"))
 
-  const {value} = await skip(readLine(Readable.from(new Encoder(fd))), 2)
+  const {
+    value
+  } = await skip(readLine(Readable.from(new FormDataEncoder(fd))), 2)
 
   t.is(
     value,
@@ -180,7 +184,9 @@ test("Yields Content-Type header for a File", async t => {
     type: "text/plain"
   })
 
-  const {value} = await skip(readLine(Readable.from(new Encoder(fd))), 3)
+  const {
+    value
+  } = await skip(readLine(Readable.from(new FormDataEncoder(fd))), 3)
 
   t.is(value, "Content-Type: text/plain")
 })
@@ -192,7 +198,7 @@ test(
 
     fd.set("file", new File(["Some content"], "file"))
 
-    const iterable = readLine(Readable.from(new Encoder(fd)))
+    const iterable = readLine(Readable.from(new FormDataEncoder(fd)))
 
     const {value} = await skip(iterable, 3)
 
@@ -208,7 +214,7 @@ test("Yields File's content", async t => {
 
   fd.set("license", await fileFromPath(filePath))
 
-  const encoder = new Encoder(fd)
+  const encoder = new FormDataEncoder(fd)
   const iterable = readLine(Readable.from(encoder))
 
   await skip(iterable, 4)
@@ -235,7 +241,7 @@ test("Yields every appended field", async t => {
   fd.append("field", "Some string")
   fd.append("field", "Some other string")
 
-  const iterable = readLine(Readable.from(new Encoder(fd)))
+  const iterable = readLine(Readable.from(new FormDataEncoder(fd)))
 
   const {value: firstFieldDisposition} = await skip(iterable, 2)
 
@@ -267,7 +273,7 @@ test("Yields every appended File", async t => {
   fd.append("file", firstFile)
   fd.append("file", secondFile)
 
-  const iterable = readLine(Readable.from(new Encoder(fd)))
+  const iterable = readLine(Readable.from(new FormDataEncoder(fd)))
 
   const {value: firstFileDisposition} = await skip(iterable, 2)
 
@@ -300,7 +306,7 @@ test("Can be read through using Blob", async t => {
   fd.set("field", "Some field")
   fd.set("file", await fileFromPath("license", {type: "text/plain"}))
 
-  const encoder = new Encoder(fd)
+  const encoder = new FormDataEncoder(fd)
   const blob = new Blob([...encoder] as any[])
 
   t.true(
@@ -314,7 +320,7 @@ test(
   "Throws TypeError when the first argument is not a FormData instance",
   t => {
     // @ts-expect-error
-    const trap = () => new Encoder({})
+    const trap = () => new FormDataEncoder({})
 
     t.throws(trap, {
       instanceOf: TypeError,
@@ -325,7 +331,7 @@ test(
 
 test("Throws TypeError when given boundary is not a string", t => {
   // @ts-expect-error
-  const trap = () => new Encoder(new FormData(), 42)
+  const trap = () => new FormDataEncoder(new FormData(), 42)
 
   t.throws(trap, {
     instanceOf: TypeError,

lib/Encoder.ts

@@ -6,7 +6,7 @@ import isFile from "./util/isFile"
 import {FormDataLike} from "./FormDataLike"
 import {FileLike} from "./FileLike"
 
-export class Encoder {
+export class FormDataEncoder {
   /**
    * Returns boundary string
    */
@@ -230,3 +230,9 @@ export class Encoder {
     return this.encode()
   }
 }
+
+/**
+ * @deprecated Use FormDataEncoder to import the encoder class instead
+ */
+/* c8 ignore next */
+export const Encoder = FormDataEncoder