# API Reference
## Structs
### NamerProps
#### Initializer
```typescript
import { NamerProps } from 'multi-convention-namer'
const namerProps: NamerProps = { ... }
```
##### `defaultFormat`Optional
```typescript
public readonly defaultFormat: Format;
```
- *Type:* [`multi-convention-namer.Format`](#multi-convention-namer.Format)
- *Default:* raise an error if no default specified and toString invoked
When using toString(), which format should be provided?
---
##### `deleteCharacters`Optional
```typescript
public readonly deleteCharacters: string;
```
- *Type:* `string`
- *Default:* '-_'
Characters to strip from name parts.
---
##### `illegalCharacters`Optional
```typescript
public readonly illegalCharacters: string;
```
- *Type:* `string`
- *Default:* '!
Characters which will cause an error if included in a name part tested AFTER deleteCharacters.
---
##### `maxLength`Optional
```typescript
public readonly maxLength: number;
```
- *Type:* `number`
- *Default:* no limit
How long can the name be?
---
##### `maxLengthTruncateHead`Optional
```typescript
public readonly maxLengthTruncateHead: boolean;
```
- *Type:* `boolean`
- *Default:* false
If the name exceeds maxLength, should I snip the head or the tail?
---
##### `maxPartLength`Optional
```typescript
public readonly maxPartLength: number;
```
- *Type:* `number`
- *Default:* no limit
How long can a part of the name be?
---
##### `maxPartLengthTruncateHead`Optional
```typescript
public readonly maxPartLengthTruncateHead: boolean;
```
- *Type:* `boolean`
- *Default:* false
If the part exceeds maxPartLength, should I snip the head or the tail?
---
##### `uniqueSeed`Optional
```typescript
public readonly uniqueSeed: any;
```
- *Type:* `any`
- *Default:* do not include a uniquifier
Include a uniquifying suffix?
If so, this is the seed for that suffix.
---
## Classes
### Namer
#### Initializers
```typescript
import { Namer } from 'multi-convention-namer'
new Namer(parts: string[], props?: NamerProps)
```
##### `parts`Required
- *Type:* `string`[]
an array of strings to be composed into a name.
---
##### `props`Optional
- *Type:* [`multi-convention-namer.NamerProps`](#multi-convention-namer.NamerProps)
modify the behavior of namer.
---
#### Methods
##### `addPrefix`
```typescript
public addPrefix(prefix: Namer | string[], props?: NamerProps)
```
###### `prefix`Required
- *Type:* [`multi-convention-namer.Namer`](#multi-convention-namer.Namer) | `string`[]
the prefix to add.
---
###### `props`Optional
- *Type:* [`multi-convention-namer.NamerProps`](#multi-convention-namer.NamerProps)
properties to over-ride the parent props.
---
##### `addSuffix`
```typescript
public addSuffix(suffix: Namer | string[], props?: NamerProps)
```
###### `suffix`Required
- *Type:* [`multi-convention-namer.Namer`](#multi-convention-namer.Namer) | `string`[]
the suffix to add.
---
###### `props`Optional
- *Type:* [`multi-convention-namer.NamerProps`](#multi-convention-namer.NamerProps)
properties to over-ride the parent props.
---
##### `enforceMaxLength`
```typescript
public enforceMaxLength(raw: string)
```
###### `raw`Required
- *Type:* `string`
---
##### `toString`
```typescript
public toString()
```
##### `unique`
```typescript
public unique(uniqueItem: any)
```
###### `uniqueItem`Required
- *Type:* `any`
: any value to use as the seed for generating a unique hash.
---
#### Properties
##### `camel`Required
```typescript
public readonly camel: string;
```
- *Type:* `string`
camelCase.
---
##### `kebab`Required
```typescript
public readonly kebab: string;
```
- *Type:* `string`
kebab-case.
---
##### `parts`Required
```typescript
public readonly parts: string[];
```
- *Type:* `string`[]
---
##### `partsWithUnique`Required
```typescript
public readonly partsWithUnique: string[];
```
- *Type:* `string`[]
---
##### `pascal`Required
```typescript
public readonly pascal: string;
```
- *Type:* `string`
PascalCase.
---
##### `snake`Required
```typescript
public readonly snake: string;
```
- *Type:* `string`
snake_case.
---
##### `props`Optional
```typescript
public readonly props: NamerProps;
```
- *Type:* [`multi-convention-namer.NamerProps`](#multi-convention-namer.NamerProps)
---
## Enums
### Format
Too many naming conventions?
#### `KEBAB`
---
#### `PASCAL`
---
#### `SNAKE`
---
#### `CAMEL`
---