# @types/parse-full-name

> TypeScript definitions for parse-full-name

Latest version **1.2.5** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/parse-full-name
pnpm add @types/parse-full-name
yarn add @types/parse-full-name
bun add @types/parse-full-name
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.2.5 |
| Published | 2023-11-07 |
| First published | 2020-04-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51447 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/parse-full-name
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/parse-full-name
- npm.io page: https://npm.io/package/@types/parse-full-name

## Recent versions

- 1.2.5 (latest) — 2023-11-07
- 1.2.2 (ts3.6) — 2021-07-11
- 1.2.0 (ts3.0) — 2020-04-01
- 1.2.4 — 2023-10-18
- 1.2.3 — 2023-09-24
- 1.2.1 — 2021-07-08

## README

# Installation
> `npm install --save @types/parse-full-name`

# Summary
This package contains type definitions for parse-full-name (https://github.com/dschnelldavis/parse-full-name).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/parse-full-name.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/parse-full-name/index.d.ts)
````ts
export type partToReturn =
    | "title"
    | "first"
    | "middle"
    | "last"
    | "nick"
    | "suffix"
    | "error"
    | "all";

export interface Name {
    title?: string | undefined;
    first?: string | undefined;
    middle?: string | undefined;
    last?: string | undefined;
    nick?: string | undefined;
    suffix?: string | undefined;
    error?: [] | undefined;
}

/**
 * Parses a string containing a person's full name, in any format
 * @param nameToParse The name to be parsed
 * @param partToReturn The name of a single part to return
 * @param fixCase Fix case of output name
 * @param stopOnError Makes parsing errors throw JavaScript errors
 * @param useLongLists Use long prefix, suffix, and title lists
 */
export function parseFullName(
    nameToParse: string,
    partToReturn?: partToReturn,
    fixCase?: boolean | -1 | 0 | 1,
    stopOnError?: boolean | 0 | 1,
    useLongLists?: boolean | 0 | 1,
): Name;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: none

# Credits
These definitions were written by [n8](https://github.com/n8Guy).

---
_Source: https://npm.io/package/@types/parse-full-name · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._