MIMEParams class

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

Properties

[iterator]

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

Methods

delete(string)

Remove all name-value pairs whose name is name.

entries()

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.

get(string)

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

has(string)

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

keys()

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
set(string, 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
values()

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

Property Details

[iterator]

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

[iterator]: () => IterableIterator<[name, value]>

Property Value

() => IterableIterator<[name, value]>

Method Details

delete(string)

Remove all name-value pairs whose name is name.

function delete(name: string)

Parameters

name

string

entries()

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.

function entries(): IterableIterator<[name, value]>

Returns

IterableIterator<[name, value]>

get(string)

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

function get(name: string): null | string

Parameters

name

string

Returns

null | string

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

has(string)

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

function has(name: string): boolean

Parameters

name

string

Returns

boolean

keys()

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
function keys(): IterableIterator<string>

Returns

IterableIterator<string>

set(string, 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
function set(name: string, value: string)

Parameters

name

string

value

string

values()

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

function values(): IterableIterator<string>

Returns

IterableIterator<string>