# @tediousjs/connection-string

> SQL ConnectionString parser

Latest version **1.1.0** (published 2026-04-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install @tediousjs/connection-string
pnpm add @tediousjs/connection-string
yarn add @tediousjs/connection-string
bun add @tediousjs/connection-string
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2026-04-15 |
| First published | 2021-01-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 33.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 9 |
| Author | Dan Hensby |
| Maintainers | arthurschreiber, dhensby |
| Keywords | mssql, tsql, connectionstring |

## Links

- npm: https://www.npmjs.com/package/@tediousjs/connection-string
- Repository: https://github.com/tediousjs/connection-string
- Homepage: https://github.com/tediousjs/connection-string#readme
- Issues: https://github.com/tediousjs/connection-string/issues
- npm.io page: https://npm.io/package/@tediousjs/connection-string

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 1.1.0 (latest) — 2026-04-15
- 1.0.0 — 2025-06-08
- 0.6.0 — 2024-09-11
- 0.5.0 — 2023-08-09
- 0.4.4 — 2023-08-02
- 0.4.3 — 2023-08-01
- 0.4.2 — 2023-01-19
- 0.4.1 — 2022-06-07
- 0.4.0 — 2022-04-27
- 0.3.0 — 2021-01-21
- 0.2.0 — 2021-01-21
- 0.1.0 — 2021-01-21

## README

# Connection String Parser

[![npm version](https://badge.fury.io/js/@tediousjs%2Fconnection-string.svg)](https://www.npmjs.com/package/@tediousjs/connection-string)
[![Lint, Test & Release](https://github.com/tediousjs/connection-string/actions/workflows/nodejs.yml/badge.svg)](https://github.com/tediousjs/connection-string/actions/workflows/nodejs.yml)

This node library is designed to allow the parsing of Connection Strings see https://docs.microsoft.com/en-us/dotnet/api/system.data.sqlclient.sqlconnection.connectionstring

The library also provides the ability to parse SQL Connection Strings.

# Usage

## Parsing connection strings

The library comes with a generic connection string parser that will parse through valid connection strings and produce a key-value
readonly Map of the entries in that string. No additional validation is performed.

```js
const { parse } = require('@tediousjs/connection-string');

const connectionString = 'User ID=user;Password=password;Initial Catalog=AdventureWorks;Server=MySqlServer';

const parsed = parse(connectionString);

console.log(parsed);
```

Output to the console will be:

```
Map(4) {
  'user id' => 'user',
  'password' => 'password',
  'initial catalog' => 'AdventureWorks',
  'server' => 'MySqlServer'
}
```

## Parsing SQL connection strings

SQL connection strings can be parsed to a JSON object using the `toSchema()` method and the provided
`MSSQL_SCHEMA`.

```js
const { parse, MSSQL_SCHEMA } = require('@tediousjs/connection-string');

const connectionString = 'User ID=user;Password=password;Initial Catalog=AdventureWorks;Server=MySqlServer';

const parsed = parse(connectionString);

console.log(parsed.toSchema(MSSQL_SCHEMA));
```

Output to console will be:

```json
{
  "data source": "MySqlServer",
  "initial catalog": "AdventureWorks",
  "password": "password",
  "user id":"user"
}
```

NB: The `Server` property from the connection string has been re-written to the value `Data Source`

## Custom schemas

If you need to parse a connection string into a custom schema, the format is as follows:

```ts
import { parse } from '@tediousjs/connection-string';

// a keyed map of name => config
const schema = {
    'a string': {
        type: 'string',
        default: 'a default value',
        aliases: ['other', 'allowed', 'names'],
    },
    'a number': {
        type: 'number',
        default: 123,
    },
    'a boolean': {
        type: 'boolean',
        default: true,
    },
};

const parsed = parse('a string=test;a number=987;a boolean=false;other value=missing');
console.log(parsed.toSchema(schema));
```

Output:

```json
{
  "a string": "test",
  "a number": 987,
  "a boolean": false
}
```

## Accessing properties

The parsed connection string object is a readonly `Map` with an overloadded `get()` method allowing
coercion of the value:

```ts
import { parse } from '@tediousjs/connection-string';
const parsed = parse('a string=test;a number=987;a boolean=false;other value=missing');
// all values are strings by default
console.log(parsed.get('a number')); // "987"
// values can be coersed to an expected type
console.log(parsed.get('a number', 'number')); // 987
// coersion will be permissive in its type coersion
console.log(parsed.get('a number', 'boolean')); // true
```

---
_Source: https://npm.io/package/@tediousjs/connection-string · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._