File: repl.txt

package info (click to toggle)
node-stdlib 0.0.96%2Bds1%2B~cs0.0.429-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 421,476 kB
  • sloc: javascript: 1,562,831; ansic: 109,702; lisp: 49,823; cpp: 27,224; python: 7,871; sh: 6,807; makefile: 6,089; fortran: 3,102; awk: 387
file content (37 lines) | stat: -rw-r--r-- 1,013 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

{{alias}}( value )
    Tests if a value is a gzip buffer.

    A gzip buffer is defined as either a Node.js Buffer or Uint8Array which
    contains a 10-byte header, a body containing the compressed payload, and an
    8-byte footer containing a CRC-32 checksum and the length of the original
    uncompressed data, modulo 2^32.

    This function only examines the 10-byte header to ensure the header includes
    the expected magic number and compression method. The function does not
    perform an integrity check.

    Parameters
    ----------
    value: any
        Value to test.

    Returns
    -------
    bool: boolean
        Boolean indicating whether value is a gzip buffer.

    Examples
    --------
    > var buf = new {{alias:@stdlib/array/uint8}}( 20 );
    > buf[ 0 ] = 31;  // 0x1f => magic number
    > buf[ 1 ] = 139; // 0x8b
    > buf[ 2 ] = 8;   // 0x08 => compression method
    > var bool = {{alias}}( buf )
    true
    > bool = {{alias}}( [] )
    false

    See Also
    --------