collectype

collectype v0.13.0

---

collectype / factory/urls/urlProtocol / urlProtocolFactory

Function: urlProtocolFactory()

urlProtocolFactory<T, C>(ctx, oper): <K>(field, target) => C

Defined in: factory/urls/urlProtocol.ts:34

Creates a predicate filter for URL protocol comparison using PredicType.url.protocol.

Type Parameters

T

T

The item type in the collection.

C

C extends Wherable<T, C>

The Wherable context type (must extend Wherable<T, C>).

Parameters

ctx

C

The context (usually a collection) supporting the where method.

oper

UrlProtocolOper

The URL protocol operation to perform.

Returns

Returns a function that takes a URL field on T, compares its protocol, and filters the context.

<K>(field, target) => C

Example

// Example based on sample/models/Person and sample/data/person
import { BaseFunctions, urlProtocolFactory } from 'collectype';
import { Person } from '../../../sample/models/Person';
import { people } from '../../../sample/data/person';

class PersonFunctions extends BaseFunctions<Person> {
  urlProtocolEquals = urlProtocolFactory<Person, this>(this, 'equals');
}

const fn = new PersonFunctions(people);
const filtered = fn.urlProtocolEquals('website', 'https:');
// filtered contains people whose website protocol equals the target value

Remarks

• Only fields of type URL are supported.
• The operation and target must match the signature of PredicType.url.protocol.
• Returns a new filtered context; does not mutate the original.

This site is open source. Improve this page.