# @writetome51/public-array-filter

> Array-manipulating class with methods that narrow down the content of the array

Latest version **4.0.0** (published 2019-06-10) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2019-06-10 |
| First published | 2018-10-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 14.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Steve Thompson |
| Maintainers | writetome51 |
| Keywords | array, filter, manipulation, typescript, class |

## Links

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

## Dependencies (8)

- [error-if-not-string](https://npm.io/package/error-if-not-string.md) ^1.0.0
- [@writetome51/set-array](https://npm.io/package/@writetome51/set-array.md) ^1.0.2
- [@writetome51/array-get-by-test](https://npm.io/package/@writetome51/array-get-by-test.md) ^1.0.1
- [@writetome51/is-array-not-array](https://npm.io/package/@writetome51/is-array-not-array.md) ^1.0.0
- [@writetome51/is-object-not-object](https://npm.io/package/@writetome51/is-object-not-object.md) ^1.0.0
- [@writetome51/public-array-container](https://npm.io/package/@writetome51/public-array-container.md) ^3.0.0
- [@writetome51/get-array-from-property](https://npm.io/package/@writetome51/get-array-from-property.md) ^1.1.1
- [@writetome51/public-array-container-by-type-implementation](https://npm.io/package/@writetome51/public-array-container-by-type-implementation.md) ^1.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) — 2019-06-10
- 3.0.0 — 2019-04-17
- 2.0.1 — 2019-03-05
- 2.0.0 — 2018-12-18
- 1.0.7 — 2018-12-15
- 1.0.5 — 2018-11-20
- 1.0.4 — 2018-11-05
- 1.0.3 — 2018-11-03
- 1.0.2 — 2018-10-26

## README

# PublicArrayFilter

An array-manipulating Typescript/Javascript class with methods that   
narrow down the content of the array it contains.

## 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
byTest(testFunction): this
    // Narrows down this.data to only the values that pass `testFunction`.
    // testFunction = function(currentValue, currentIndex?, theArray?): boolean

byType(
    type: 'number' | 'boolean' | 'string' | 'array' | 'object' | 'function' | 'undefined' | 'null'
): this
    // Narrows down this.data to only values that are the specified type.
    // Here, 'null' is considered its own type, separate from 'object'.
    // You can also pass 'array' as a type.  Passing 'object' will match with objects and arrays.
``` 
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

PublicArrayFilter<--[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-filter
```

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

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

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