# @writetome51/public-array-item-inserter

> an array-manipulating typescript/javascript class with methods that increase the length of the array

Latest version **1.0.2** (published 2018-10-26) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @writetome51/public-array-item-inserter
pnpm add @writetome51/public-array-item-inserter
yarn add @writetome51/public-array-item-inserter
bun add @writetome51/public-array-item-inserter
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2018-10-26 |
| First published | 2018-10-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 10.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Steve Thompson |
| Maintainers | writetome51 |
| Keywords | array, manipulation, insert, item, items, typescript, class |

## Links

- npm: https://www.npmjs.com/package/@writetome51/public-array-item-inserter
- Repository: https://github.com/writetome51/public-array-item-inserter
- Homepage: https://github.com/writetome51/public-array-item-inserter#readme
- Issues: https://github.com/writetome51/public-array-item-inserter/issues
- npm.io page: https://npm.io/package/@writetome51/public-array-item-inserter

## Dependencies (3)

- [@writetome51/array-insert-at](https://npm.io/package/@writetome51/array-insert-at.md) latest
- [@writetome51/array-insert-middle](https://npm.io/package/@writetome51/array-insert-middle.md) latest
- [@writetome51/public-array-container](https://npm.io/package/@writetome51/public-array-container.md) latest

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2018-10-26

## README

# PublicArrayInserter

An array-manipulating Typescript/Javascript class with methods that   
increase the length of the array.

## Constructor
```ts
constructor(data? = [])   // 'data' is assigned to this.data .
```

You can reset the array by accessing the class `.data` property:
```ts
this.data = [1,2,3,4];
```

## Properties
```ts
data : any[]  // the actual array

className: string (read-only)
```

## Methods
<details>
<summary>view methods</summary>

```ts
at(index, values): this 
    // inserts values at index.  index can be negative or positive.
    // If positive, existing items beginning at that index will be pushed to 
    // the right to make room.  If negative, existing items ending at that 
    // index will be pushed to the left to make room.
    
middle(values, offset? = 0): this
    // inserts values in middle of this.data .
    // By default, if the array has odd number of items, values will be 
    // inserted just before the middle item. If you want to change the insert 
    // position, set the optional offset parameter to + or - whatever integer 
    // you want.
```
The methods below are not important to know about in order to use this  
class.  They're inherited from [BaseClass](https://github.com/writetome51/typescript-base-class#baseclass) .
```ts
protected   _createGetterAndOrSetterForEach(
		propertyNames: string[],
		configuration: IGetterSetterConfiguration
	   ) : void
    /*********************
    Use this method when you have a bunch of properties that need getter and/or 
    setter functions that all do the same thing. You pass in an array of string 
    names of those properties, and the method attaches the same getter and/or 
    setter function to each property.
    IGetterSetterConfiguration is this object:
    {
        get_setterFunction?: (
             propertyName: string, index?: number, propertyNames?: string[]
        ) => Function,
	    // get_setterFunction takes the property name as first argument and 
	    // returns the setter function.  The setter function must take one 
	    // parameter and return void.
	    
        get_getterFunction?: (
             propertyName: string, index?: number, propertyNames?: string[]
        ) => Function
	    // get_getterFunction takes the property name as first argument and 
	    // returns the getter function.  The getter function must return something.
    }
    *********************/ 
	   
	   
protected   _returnThis_after(voidExpression: any) : this
    // voidExpression is executed, then function returns this.
    // Even if voidExpression returns something, the returned data isn't used.

protected   _errorIfPropertyHasNoValue(
                property: string, // can contain dot-notation, i.e., 'property.subproperty'
                propertyNameInError? = ''
            ) : void
    // If value of this[property] is undefined or null, it triggers fatal error:
    // `The property "${propertyNameInError}" has no value.`
```
</details>

## Inheritance Chain

PublicArrayInserter<--[PublicArrayContainer](https://github.com/writetome51/public-array-container#publicarraycontainer)<--[BaseClass](https://github.com/writetome51/typescript-base-class#baseclass)

## Installation

```bash
npm i  @writetome51/public-array-inserter
```

## Loading
```ts
// if using Typescript:
import {PublicArrayInserter} from '@writetome51/public-array-inserter';
// if using ES5 Javascript:
var PublicArrayInserter = 
         require('@writetome51/public-array-inserter').PublicArrayInserter;
```

## License
[MIT](https://choosealicense.com/licenses/mit/)

---
_Source: https://npm.io/package/@writetome51/public-array-item-inserter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._