@stdlib/os
Version:
OS utilities.
48 lines (42 loc) • 1.15 kB
TypeScript
/*
* @license Apache-2.0
*
* Copyright (c) 2020 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// TypeScript Version: 4.1
/**
* Platform byte order.
*
* ## Notes
*
* Possible values:
*
* - `'little-endian'`
* - `'big-endian'`
* - `'mixed-endian'`
* - `'unknown'`
*
* @example
* if ( BYTE_ORDER === 'little-endian' ) {
* console.log( 'Least significant byte comes first...' );
* } else if ( BYTE_ORDER === 'big-endian' ) {
* console.log( 'Most significant byte comes first...' );
* } else {
* console.log( 'This is uncommon...' );
* }
*/
declare const BYTE_ORDER: string;
// EXPORTS //
export = BYTE_ORDER;