# @writetome51/public-array-container

> an abstract typescript/javascript class meant to be extended by array-manipulating classes

Latest version **4.0.0** (published 2020-08-07) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2020-08-07 |
| First published | 2018-10-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Steve Thompson |
| Maintainers | writetome51 |
| Keywords | array, manipulation, typescript, abstract, class |

## Links

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

## Dependencies (2)

- [error-if-not-array](https://npm.io/package/error-if-not-array.md) ^2.0.0
- [@writetome51/base-class](https://npm.io/package/@writetome51/base-class.md) ^2.0.0

## 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

- 4.0.0 (latest) — 2020-08-07
- 3.0.0 — 2019-06-09
- 2.0.3 — 2019-04-15
- 2.0.2 — 2019-03-04
- 2.0.1 — 2018-12-17
- 2.0.0 — 2018-12-16
- 1.1.1 — 2018-12-13
- 1.0.4 — 2018-11-20
- 1.0.3 — 2018-11-15
- 1.0.2 — 2018-10-26
- 1.0.1 — 2018-10-25
- 1.0.0 — 2018-10-24

## README

# PublicArrayContainer

A TypeScript/JavaScript abstract class meant to be extended by array-manipulating  
classes.

## Usage Example
```ts
export class PublicArrayContent extends PublicArrayContainer {

    constructor(data = []) {
        super(data); 
    }

    // ... more code ...

}
```

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

## Properties
```ts
data : any[]  
    // The actual array. Whenever assigned a value, its type is validated.
    
className : string (read-only)
```

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

```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

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

## Installation
```
npm i @writetome51/public-array-container
```

## Loading
```js
// if using Typescript:
import { PublicArrayContainer } from '@writetome51/public-array-container';
```

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

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