# parse-listen-string

**Repository Path**: mirrors_silverwind/parse-listen-string

## Basic Information

- **Project Name**: parse-listen-string
- **Description**: Parse a HTTP server listen string
- **Primary Language**: Unknown
- **License**: BSD-2-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-23
- **Last Updated**: 2026-10-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# parse-listen-string
[![](https://img.shields.io/npm/v/parse-listen-string.svg?style=flat)](https://www.npmjs.org/package/parse-listen-string) [![](https://img.shields.io/npm/dm/parse-listen-string.svg)](https://www.npmjs.org/package/parse-listen-string) [![](https://packagephobia.com/badge?p=parse-listen-string)](https://packagephobia.com/result?p=parse-listen-string)

Node.js module to parse a listen string like `0.0.0.0:443`.

## Usage

```sh
pnpm add parse-listen-string
```

```js
import {parseListenString} from "parse-listen-string";

parseListenString("0.0.0.0:80")
//=> {host: "0.0.0.0", port: 80, proto: "http"}

parseListenString("https://[::1]:443")
//=> {host: "::1", port: 443, proto: "https"}
```

## API
### parseListenString(listenString)

- `listenString` *String* or *Number*: A listen string to parse

Returns an object or `null` if string can not be parsed. Object properties:

- `proto` *String*: Protocol, either `http` or `https`
- `host` *String*: Listen host in form of an IP address
- `port` *Number*: Listen port
- `path` *String*: Unix socket path, this is mutually exclusive with `host` and `port`

© [silverwind](https://github.com/silverwind), distributed under BSD licence