README
Network Libs
The project of gathering information of network address.
This project was generated by Vessel. For a simple and quick reference, click here.
About
서버 네트워크 정보를 얻기 위해 사용되는 모듈들에 대해 집합적인 형태로 제공되는 패키지.
Installation
해당 라이브러리를 사용 할 프로젝트에서는 아래와 같이 의존성 모듈로 설치한다.
$ npm install --save @mornya/network-libs
or
$ yarn add @mornya/network-libs
Modules in the package
본 패키지에는 아래와 같은 모듈들을 포함한다.
제공되는 모듈과 메소드 사용법 등은 코드 스니핏을 참고한다.
Network module
네트워크 모듈은 다음과 같은 메소드들을 제공한다.
Network.getIPv4
서버의 IP(v4) 정보를 얻는다.
function getIPv4 (interfaceName?: InterfaceName): NetworkInterfaceInfo;
Network.getIPv6
서버의 IP(v6) 정보를 얻는다.
function getIPv6 (interfaceName?: InterfaceName): NetworkInterfaceInfo;
Network.getLoopback
서버의 루프백 IP(v4) 정보를 얻는다.
function getLoopback (): string;
Network.getDNS
서버의 DNS IP(v4) 정보를 얻는다.
function getDNS (resolvFilename: string = defaultResolvFile): string[];
Network.getMACAddress
서버의 인터페이스별 MAC 주소 정보를 얻는다.
function getMACAddress (ipv4Info: NetworkInterfaceInfo, interfaceName?: InterfaceName): string;
Network.getAddress
서버의 IP(v4, v6), DNS, 루프백 주소 등의 정보를 얻는다.
function getAddress (addressOptions: AddressOptions): AddressResult;
Change Log
프로젝트 변경사항은 CHANGELOG.md 파일 참조.
License
프로젝트 라이센스는 LICENSE 파일 참조.