ip-num
Version:
A TypeScript library for working with IPv4, IPv6 and ASN numbers. It provides representations of these internet protocol numbers with the ability to perform various IP related operations like parsing, validating etc. on them
76 lines • 2.43 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.Octet = void 0;
const Validator_1 = require("./Validator");
/**
* A binary representation of a 8 bit value.
*
* {@see https://en.wikipedia.org/wiki/Octet_(computing)} for more information on Octets
*
* An octet is used in the textual representation of an {@link IPv4} number, where the IP number value is divided
* into 4 octets
*/
class Octet {
/**
* Constructor for creating an instance of an Octet.
*
* The constructor parameter given could either be a string or number.
*
* If a string, it is the string representation of the numeric value of the octet
* If a number, it is the numeric representation of the value of the octet
*
* @param {string | number} givenValue value of the octet to be created.
*/
constructor(givenValue) {
let octetValue;
if (typeof givenValue === 'string') {
octetValue = parseInt(givenValue);
}
else {
octetValue = givenValue;
}
let [isValid, message] = Validator_1.Validator.isValidIPv4Octet(BigInt(octetValue));
if (!isValid) {
throw Error(message.filter(msg => { return msg !== ''; }).toString());
}
this.value = octetValue;
}
/**
* Convenience method for creating an Octet out of a string value representing the value of the octet
*
* @param {string} rawValue the octet value in string
* @returns {Octet} the Octet instance
*/
static fromString(rawValue) {
return new Octet(rawValue);
}
;
/**
* Convenience method for creating an Octet out of a numeric value representing the value of the octet
*
* @param {number} rawValue the octet value in number
* @returns {Octet} the Octet instance
*/
static fromNumber(rawValue) {
return new Octet(rawValue);
}
;
/**
* Method to get the numeric value of the octet
*
* @returns {number} the numeric value of the octet
*/
getValue() {
return this.value;
}
/**
* Returns a decimal representation of the value of the octet in string
*
* @returns {string} a decimal representation of the value of the octet in string
*/
toString() {
return this.value.toString(10);
}
}
exports.Octet = Octet;
//# sourceMappingURL=Octet.js.map