DocsReferenceGuidesBlog
Discord logo
Discord
GitHub logo
Bun

class

util.MIMEParams

class MIMEParams

The MIMEParams API provides read and write access to the parameters of a MIMEType.

  • [Symbol.iterator](): Iterator<[name: string, value: string]>;

    Returns an iterator over each of the name-value pairs in the parameters.

  • name: string
    ): void;

    Remove all name-value pairs whose name is name.

  • entries(): Iterator<[name: string, value: string]>;

    Returns an iterator over each of the name-value pairs in the parameters. Each item of the iterator is a JavaScript Array. The first item of the array is the name, the second item of the array is the value.

  • name: string
    ): null | string;

    Returns the value of the first name-value pair whose name is name. If there are no such pairs, null is returned.

    @returns

    or null if there is no name-value pair with the given name.

  • name: string
    ): boolean;

    Returns true if there is at least one name-value pair whose name is name.

  • keys(): Iterator<string>;

    Returns an iterator over the names of each name-value pair.

    import { MIMEType } from 'node:util';

const { params } = new MIMEType('text/plain;foo=0;bar=1');
for (const name of params.keys()) {
  console.log(name);
}
// Prints:
//   foo
//   bar
  • name: string,
    value: string
    ): void;

    Sets the value in the MIMEParams object associated with name to value. If there are any pre-existing name-value pairs whose names are name, set the first such pair's value to value.

    import { MIMEType } from 'node:util';

const { params } = new MIMEType('text/plain;foo=0;bar=1');
params.set('foo', 'def');
params.set('baz', 'xyz');
console.log(params.toString());
// Prints: foo=def;bar=1;baz=xyz
  • values(): Iterator<string>;

    Returns an iterator over the values of each name-value pair.