time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

percent_encode.js (2567B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 // MODULES //
     22 
     23 var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
     24 var utf16ToUTF8Array = require( './../../utf16-to-utf8-array' );
     25 var format = require( './../../format' );
     26 
     27 
     28 // VARIABLES //
     29 
     30 // Character codes:
     31 var UNDERSCORE = 95|0;
     32 var PERIOD = 46|0;
     33 var HYPHEN = 45|0;
     34 var TILDE = 126|0;
     35 var ZERO = 48|0;
     36 var NINE = 57|0;
     37 var A = 65|0;
     38 var Z = 90|0;
     39 var a = 97|0;
     40 var z = 122|0;
     41 
     42 
     43 // MAIN //
     44 
     45 /**
     46 * Percent-encode a UTF-16 encoded string according to [RFC 3986][1].
     47 *
     48 * [1]: https://tools.ietf.org/html/rfc3986#section-2.1
     49 *
     50 * @param {string} str - string to percent-encode
     51 * @throws {TypeError} must provide a string
     52 * @returns {string} percent-encoded string
     53 *
     54 * @example
     55 * var str1 = 'Ladies + Gentlemen';
     56 *
     57 * var str2 = percentEncode( str1 );
     58 * // returns 'Ladies%20%2B%20Gentlemen'
     59 */
     60 function percentEncode( str ) {
     61 	var byte;
     62 	var out;
     63 	var len;
     64 	var buf;
     65 	var i;
     66 
     67 	if ( !isString( str ) ) {
     68 		throw new TypeError( format( 'invalid argument. Must provide a string. Value: `%s`.', str ) );
     69 	}
     70 	// Convert to an array of octets using UTF-8 encoding (see https://tools.ietf.org/html/rfc3986#section-2.5):
     71 	buf = utf16ToUTF8Array( str );
     72 
     73 	// Encode the string...
     74 	len = buf.length;
     75 	out = '';
     76 	for ( i = 0; i < len; i++ ) {
     77 		byte = buf[ i ];
     78 		if (
     79 			// ASCII Digits:
     80 			( byte >= ZERO && byte <= NINE ) ||
     81 
     82 			// ASCII uppercase letters:
     83 			( byte >= A && byte <= Z ) ||
     84 
     85 			// ASCII lowercase letters:
     86 			( byte >= a && byte <= z ) ||
     87 
     88 			// ASCII unreserved characters (see https://tools.ietf.org/html/rfc3986#section-2.3):
     89 			byte === HYPHEN ||
     90 			byte === PERIOD ||
     91 			byte === UNDERSCORE ||
     92 			byte === TILDE
     93 		) {
     94 			out += str.charAt( i );
     95 		} else {
     96 			// Convert an octet to hexadecimal and uppercase according to the RFC (see https://tools.ietf.org/html/rfc3986#section-2.1):
     97 			out += '%' + byte.toString( 16 ).toUpperCase();
     98 		}
     99 	}
    100 	return out;
    101 }
    102 
    103 
    104 // EXPORTS //
    105 
    106 module.exports = percentEncode;