Skip to content

cupertino-files / FilterSet

Class: FilterSet

Defined in: src/tst/filters.ts:80

Constructors

Constructor

new FilterSet(store, object): FilterSet

Defined in: src/tst/filters.ts:84

Parameters

store

ObjectStore

object

IwaObject

Returns

FilterSet

Properties

object

readonly object: IwaObject

Defined in: src/tst/filters.ts:82


store

readonly store: ObjectStore

Defined in: src/tst/filters.ts:81

Accessors

consistent

Get Signature

get consistent(): boolean

Defined in: src/tst/filters.ts:162

True when the parallel arrays line up with the rule list.

filter_offsets and filter_enabled are indexed by rule position, so a set where they are shorter than the rules is one whose later rules have no column — worth detecting rather than silently reading as column 0. An empty set with a single stray offset, which is what every fixture holds, counts as consistent.

Returns

boolean


enabled

Get Signature

get enabled(): boolean

Defined in: src/tst/filters.ts:94

Whether the app is applying this set at all.

Returns

boolean


id

Get Signature

get id(): bigint

Defined in: src/tst/filters.ts:89

Returns

bigint


mode

Get Signature

get mode(): FilterMode

Defined in: src/tst/filters.ts:104

Returns

FilterMode

Methods

describe()

describe(): string[]

Defined in: src/tst/filters.ts:189

Readable summary, one line per rule.

Returns

string[]


rules()

rules(options?): FilterRule[]

Defined in: src/tst/filters.ts:132

The rules, in stored order.

The modern list wins where both exist, matching how the apps read them; a file written before the 2016 format change carries only the older one.

Parameters

options?

ReadPredicateOptions = {}

Returns

FilterRule[]


setEnabled()

setEnabled(enabled): void

Defined in: src/tst/filters.ts:100

Parameters

enabled

boolean

Returns

void


setMode()

setMode(mode): void

Defined in: src/tst/filters.ts:108

Parameters

mode

FilterMode

Returns

void


setRuleEnabled()

setRuleEnabled(index, enabled): void

Defined in: src/tst/filters.ts:170

Turn a rule on or off without removing it.

Parameters

index

number

enabled

boolean

Returns

void

MIT licensed. Independently made — not by Apple in California. Not affiliated with or endorsed by Apple Inc.