index.js (1296B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2020 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 /** 22 * Test if a value is a gzip buffer (or Uint8Array). 23 * 24 * @module @stdlib/assert/is-gzip-buffer 25 * 26 * @example 27 * var Uint8Array = require( '@stdlib/array/uint8' ); 28 * var isgzipBuffer = require( '@stdlib/assert/is-gzip-buffer' ); 29 * 30 * var buf = new Uint8Array( 20 ); 31 * buf[ 0 ] = 31; // 0x1f => magic number 32 * buf[ 1 ] = 139; // 0x8b 33 * buf[ 2 ] = 8; // 0x08 => compression method 34 * 35 * var bool = isgzipBuffer( buf ); 36 * // returns true 37 * 38 * bool = isgzipBuffer( new Uint8Array( 20 ) ); 39 * // returns false 40 * 41 * bool = isgzipBuffer( [] ); 42 * // returns false 43 */ 44 45 // MODULES // 46 47 var isgzipBuffer = require( './main.js' ); 48 49 50 // EXPORTS // 51 52 module.exports = isgzipBuffer;