s/quality/weight/g

Author: mjackson

packages/headers/CHANGELOG.md

@@ -72,7 +72,7 @@ let ms = new Date().getTime();
 let headers = new SuperHeaders({ lastModified: ms });
 ```
 
-- Added `AcceptLanguage.prototype.accepts(language)`, `AcceptLanguage.prototype.getQuality(language)`,
+- Added `AcceptLanguage.prototype.accepts(language)`, `AcceptLanguage.prototype.getWeight(language)`,
   `AcceptLanguage.prototype.getPreferred(languages)`
 
 ```ts
@@ -85,8 +85,8 @@ header.accepts('en-GB'); // true
 header.accepts('en'); // true
 header.accepts('fr'); // false
 
-header.getQuality('en-US'); // 1
-header.getQuality('en-GB'); // 0.9
+header.getWeight('en-US'); // 1
+header.getWeight('en-GB'); // 0.9
 
 header.getPreferred(['en-GB', 'en-US']); // 'en-US'
 ```
@@ -103,8 +103,8 @@ header.accepts('text/plain'); // true
 header.accepts('text/*'); // true
 header.accepts('image/jpeg'); // false
 
-header.getQuality('text/html'); // 1
-header.getQuality('text/plain'); // 0.9
+header.getWeight('text/html'); // 1
+header.getWeight('text/plain'); // 0.9
 
 header.getPreferred(['text/html', 'text/plain']); // 'text/html'
 ```
@@ -121,8 +121,8 @@ header.accepts('deflate'); // true
 header.accepts('identity'); // true
 header.accepts('br'); // false
 
-header.getQuality('gzip'); // 1
-header.getQuality('deflate'); // 0.9
+header.getWeight('gzip'); // 1
+header.getWeight('deflate'); // 0.9
 
 header.getPreferred(['gzip', 'deflate']); // 'gzip'
 ```

packages/headers/src/lib/accept-language.test.ts

@@ -39,9 +39,9 @@ describe('Accept-Language', () => {
     assert.deepEqual(header.languages, ['en-us', 'en']);
   });
 
-  it('gets all qualities', () => {
+  it('gets all weights', () => {
     let header = new AcceptLanguage('en-US,en;q=0.9');
-    assert.deepEqual(header.qualities, [1, 0.9]);
+    assert.deepEqual(header.weights, [1, 0.9]);
   });
 
   it('checks if a language is acceptable', () => {
@@ -53,14 +53,14 @@ describe('Accept-Language', () => {
     assert.equal(header.accepts('fi'), false);
   });
 
-  it('gets the correct quality values', () => {
+  it('gets the correct weight values', () => {
     let header = new AcceptLanguage('en-US,en;q=0.9,fr;q=0.8');
-    assert.equal(header.getQuality('en-US'), 1);
-    assert.equal(header.getQuality('*'), 1);
-    assert.equal(header.getQuality('en'), 1);
-    assert.equal(header.getQuality('en-GB'), 0.9);
-    assert.equal(header.getQuality('fr'), 0.8);
-    assert.equal(header.getQuality('fi'), 0);
+    assert.equal(header.getWeight('en-US'), 1);
+    assert.equal(header.getWeight('*'), 1);
+    assert.equal(header.getWeight('en'), 1);
+    assert.equal(header.getWeight('en-GB'), 0.9);
+    assert.equal(header.getWeight('fr'), 0.8);
+    assert.equal(header.getWeight('fi'), 0);
   });
 
   it('gets the preferred language', () => {
@@ -112,8 +112,8 @@ describe('Accept-Language', () => {
   it('uses forEach correctly', () => {
     let header = new AcceptLanguage('en-US,en;q=0.9');
     let result: [string, number][] = [];
-    header.forEach((language, quality) => {
-      result.push([language, quality]);
+    header.forEach((language, weight) => {
+      result.push([language, weight]);
     });
     assert.deepEqual(result, [
       ['en-us', 1],
@@ -131,13 +131,13 @@ describe('Accept-Language', () => {
     assert.equal(header.toString(), 'en-us,en;q=0.9');
   });
 
-  it('handles setting empty quality values', () => {
+  it('handles setting empty weight values', () => {
     let header = new AcceptLanguage();
     header.set('en-US');
     assert.equal(header.get('en-US'), 1);
   });
 
-  it('overwrites existing quality values', () => {
+  it('overwrites existing weight values', () => {
     let header = new AcceptLanguage('en;q=0.9');
     header.set('en', 1);
     assert.equal(header.get('en'), 1);

packages/headers/src/lib/accept-language.ts

@@ -24,17 +24,17 @@ export class AcceptLanguage implements HeaderValue, Iterable<[string, number]> {
           if (params.length < 1) continue;
 
           let language = params[0][0];
-          let quality = 1;
+          let weight = 1;
 
           for (let i = 1; i < params.length; i++) {
             let [key, value] = params[i];
             if (key === 'q') {
-              quality = Number(value);
+              weight = Number(value);
               break;
             }
           }
 
-          this.#map.set(language.toLowerCase(), quality);
+          this.#map.set(language.toLowerCase(), weight);
         }
       } else if (isIterable(init)) {
         for (let value of init) {
@@ -66,9 +66,9 @@ export class AcceptLanguage implements HeaderValue, Iterable<[string, number]> {
   }
 
   /**
-   * An array of all quality values in the header.
+   * An array of all weight values in the header.
    */
-  get qualities(): number[] {
+  get weights(): number[] {
     return Array.from(this.#map.values());
   }
 
@@ -78,16 +78,16 @@ export class AcceptLanguage implements HeaderValue, Iterable<[string, number]> {
    * @returns `true` if the language is acceptable, `false` otherwise.
    */
   accepts(language: string): boolean {
-    return this.getQuality(language) > 0;
+    return this.getWeight(language) > 0;
   }
 
   /**
-   * Gets the quality of a language with the given locale identifier. Performs wildcard and subtype
+   * Gets the weight of a language with the given locale identifier. Performs wildcard and subtype
    * matching, so `en` matches `en-US` and `en-GB`, and `*` matches all languages.
    * @param language The locale identifier of the language to get.
-   * @returns The quality of the language, or `0` if it is not in the header.
+   * @returns The weight of the language, or `0` if it is not in the header.
    */
-  getQuality(language: string): number {
+  getWeight(language: string): number {
     let [base, subtype] = language.toLowerCase().split('-');
 
     for (let [key, value] of this) {
@@ -110,7 +110,7 @@ export class AcceptLanguage implements HeaderValue, Iterable<[string, number]> {
    */
   getPreferred(languages: string[]): string | null {
     let sorted = languages
-      .map((language) => [language, this.getQuality(language)] as const)
+      .map((language) => [language, this.getWeight(language)] as const)
       .sort((a, b) => b[1] - a[1]);
 
     let first = sorted[0];
@@ -119,22 +119,22 @@ export class AcceptLanguage implements HeaderValue, Iterable<[string, number]> {
   }
 
   /**
-   * Gets the quality of a language with the given locale identifier. If it is not in the header
+   * Gets the weight of a language with the given locale identifier. If it is not in the header
    * verbatim, this returns `null`.
    * @param language The locale identifier of the language to get.
-   * @returns The quality of the language, or `null` if it is not in the header.
+   * @returns The weight of the language, or `null` if it is not in the header.
    */
   get(language: string): number | null {
     return this.#map.get(language.toLowerCase()) ?? null;
   }
 
   /**
-   * Sets a language with the given quality.
+   * Sets a language with the given weight.
    * @param language The locale identifier of the language to set.
-   * @param quality The quality of the language. Defaults to 1.
+   * @param weight The weight of the language. Defaults to 1.
    */
-  set(language: string, quality = 1): void {
-    this.#map.set(language.toLowerCase(), quality);
+  set(language: string, weight = 1): void {
+    this.#map.set(language.toLowerCase(), weight);
     this.#sort();
   }
 
@@ -171,11 +171,11 @@ export class AcceptLanguage implements HeaderValue, Iterable<[string, number]> {
   }
 
   forEach(
-    callback: (language: string, quality: number, header: AcceptLanguage) => void,
+    callback: (language: string, weight: number, header: AcceptLanguage) => void,
     thisArg?: any,
   ): void {
-    for (let [language, quality] of this) {
-      callback.call(thisArg, language, quality, this);
+    for (let [language, weight] of this) {
+      callback.call(thisArg, language, weight, this);
     }
   }
 
@@ -189,8 +189,8 @@ export class AcceptLanguage implements HeaderValue, Iterable<[string, number]> {
   toString(): string {
     let pairs: string[] = [];
 
-    for (let [language, quality] of this.#map) {
-      pairs.push(`${language}${quality === 1 ? '' : `;q=${quality}`}`);
+    for (let [language, weight] of this.#map) {
+      pairs.push(`${language}${weight === 1 ? '' : `;q=${weight}`}`);
     }
 
     return pairs.join(',');

packages/headers/src/lib/accept.test.ts

@@ -39,9 +39,9 @@ describe('Accept', () => {
     assert.deepEqual(header.mediaTypes, ['text/html', 'application/json']);
   });
 
-  it('gets all qualities', () => {
+  it('gets all weights', () => {
     let header = new Accept('text/html,application/json;q=0.9');
-    assert.deepEqual(header.qualities, [1, 0.9]);
+    assert.deepEqual(header.weights, [1, 0.9]);
   });
 
   it('checks if a media type is acceptable', () => {
@@ -53,14 +53,14 @@ describe('Accept', () => {
     assert.equal(header.accepts('image/jpeg'), false);
   });
 
-  it('gets the correct quality values', () => {
+  it('gets the correct weight values', () => {
     let header = new Accept('text/html,text/*;q=0.9,application/json;q=0.8');
-    assert.equal(header.getQuality('text/html'), 1);
-    assert.equal(header.getQuality('*/*'), 1);
-    assert.equal(header.getQuality('text/*'), 1);
-    assert.equal(header.getQuality('text/plain'), 0.9);
-    assert.equal(header.getQuality('application/json'), 0.8);
-    assert.equal(header.getQuality('image/jpeg'), 0);
+    assert.equal(header.getWeight('text/html'), 1);
+    assert.equal(header.getWeight('*/*'), 1);
+    assert.equal(header.getWeight('text/*'), 1);
+    assert.equal(header.getWeight('text/plain'), 0.9);
+    assert.equal(header.getWeight('application/json'), 0.8);
+    assert.equal(header.getWeight('image/jpeg'), 0);
   });
 
   it('gets the preferred media type', () => {
@@ -110,8 +110,8 @@ describe('Accept', () => {
   it('uses forEach correctly', () => {
     let header = new Accept('text/html,application/json;q=0.9');
     let result: [string, number][] = [];
-    header.forEach((mediaType, quality) => {
-      result.push([mediaType, quality]);
+    header.forEach((mediaType, weight) => {
+      result.push([mediaType, weight]);
     });
     assert.deepEqual(result, [
       ['text/html', 1],
@@ -129,13 +129,13 @@ describe('Accept', () => {
     assert.equal(header.toString(), 'text/html,application/json;q=0.9');
   });
 
-  it('handles setting empty quality values', () => {
+  it('handles setting empty weight values', () => {
     let header = new Accept();
     header.set('text/html');
     assert.equal(header.get('text/html'), 1);
   });
 
-  it('overwrites existing quality values', () => {
+  it('overwrites existing weight values', () => {
     let header = new Accept('text/html,application/json;q=0.9');
     header.set('application/json', 0.8);
     assert.equal(header.get('application/json'), 0.8);