@stdlib/array/byte-orders/docs/types/index.d.ts

Arrays.

/*
* @license Apache-2.0
*
* Copyright (c) 2024 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

/**
* Returns a list of byte orders.
*
* ## Notes
*
* -   The output array contains the following orders:
*
*     -   little-endian: bytes are ordered from least-to-most significant byte.
*     -   big-endian: bytes are ordered from most-to-least significant byte.
*
* @returns list of byte orders
*
* @example
* var list = byteOrders();
* // e.g., returns [ 'little-endian', 'big-endian' ]
*/
declare function byteOrders(): Array<string>;


// EXPORTS //

export = byteOrders;