Current File : //lib/node_modules/npm/node_modules/smart-buffer/typings/utils.d.ts
/// <reference types="node" />
import { SmartBuffer } from './smartbuffer';
import { Buffer } from 'buffer';
/**
* Error strings
*/
declare const ERRORS: {
INVALID_ENCODING: string;
INVALID_SMARTBUFFER_SIZE: string;
INVALID_SMARTBUFFER_BUFFER: string;
INVALID_SMARTBUFFER_OBJECT: string;
INVALID_OFFSET: string;
INVALID_OFFSET_NON_NUMBER: string;
INVALID_LENGTH: string;
INVALID_LENGTH_NON_NUMBER: string;
INVALID_TARGET_OFFSET: string;
INVALID_TARGET_LENGTH: string;
INVALID_READ_BEYOND_BOUNDS: string;
INVALID_WRITE_BEYOND_BOUNDS: string;
};
/**
* Checks if a given encoding is a valid Buffer encoding. (Throws an exception if check fails)
*
* @param { String } encoding The encoding string to check.
*/
declare function checkEncoding(encoding: BufferEncoding): void;
/**
* Checks if a given number is a finite integer. (Throws an exception if check fails)
*
* @param { Number } value The number value to check.
*/
declare function isFiniteInteger(value: number): boolean;
/**
* Checks if a length value is valid. (Throws an exception if check fails)
*
* @param { Number } length The value to check.
*/
declare function checkLengthValue(length: any): void;
/**
* Checks if a offset value is valid. (Throws an exception if check fails)
*
* @param { Number } offset The value to check.
*/
declare function checkOffsetValue(offset: any): void;
/**
* Checks if a target offset value is out of bounds. (Throws an exception if check fails)
*
* @param { Number } offset The offset value to check.
* @param { SmartBuffer } buff The SmartBuffer instance to check against.
*/
declare function checkTargetOffset(offset: number, buff: SmartBuffer): void;
interface Buffer {
readBigInt64BE(offset?: number): bigint;
readBigInt64LE(offset?: number): bigint;
readBigUInt64BE(offset?: number): bigint;
readBigUInt64LE(offset?: number): bigint;
writeBigInt64BE(value: bigint, offset?: number): number;
writeBigInt64LE(value: bigint, offset?: number): number;
writeBigUInt64BE(value: bigint, offset?: number): number;
writeBigUInt64LE(value: bigint, offset?: number): number;
}
/**
* Throws if Node.js version is too low to support bigint
*/
declare function bigIntAndBufferInt64Check(bufferMethod: keyof Buffer): void;
export { ERRORS, isFiniteInteger, checkEncoding, checkOffsetValue, checkLengthValue, checkTargetOffset, bigIntAndBufferInt64Check };
Mini Shell