On this page

C

util.MIMEParams

History

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

new MIMEParams(): MIMEParams

Creates a new MIMEParams object by with empty parameters

import { MIMEParams } from 'node:util';

const myParams = new MIMEParams();
JavaScript
const { MIMEParams } = require('node:util');

const myParams = new MIMEParams();
JavaScript
 
mimeParams.delete(name): void
Attributes
name:string

Remove all name-value pairs whose name is name.

mimeParams.entries(): Iterator
Returns:Iterator

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.

mimeParams.get(name): string | null
Attributes
name:string
Returns:string | null
A string or null if there is no name-value pair with the given name.

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

mimeParams.has(name): boolean
Attributes
name:string
Returns:boolean

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

mimeParams.keys(): Iterator
Returns:Iterator

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
JavaScript
const { MIMEType } = require('node:util');

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

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
JavaScript
const { MIMEType } = require('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
JavaScript
 
mimeParams.values(): Iterator
Returns:Iterator

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

mimeParams[Symbol.iterator](): Iterator
Returns:Iterator

Alias for mimeParams.entries().

import { MIMEType } from 'node:util';

const { params } = new MIMEType('text/plain;foo=bar;xyz=baz');
for (const [name, value] of params) {
  console.log(name, value);
}
// Prints:
//   foo bar
//   xyz baz
JavaScript
const { MIMEType } = require('node:util');

const { params } = new MIMEType('text/plain;foo=bar;xyz=baz');
for (const [name, value] of params) {
  console.log(name, value);
}
// Prints:
//   foo bar
//   xyz baz
JavaScript
Previousutil.MIMETypeNextutil.parseArgs