Function

Static Public Summary
public	convertToValidExpression(param: number \| numberSearchSyntax): Object Convert the param to valid expression object for filter function
public	excludeDefaultBooleanProperties(searchObject: searchParameters): searchParameters Remove the default boolean properties
public	excludeDefaultNumberProperties(searchObject: searchParameters): searchParameters Remove the default number properties
public	excludeDefaultStringProperties(searchObject: searchParameters): searchParameters Remove the default string properties
public	filterByBoolean(set: Set<TPN>, propertiesMap: Map<string, boolean>): Set<TPN> Filter the set based on boolean properties
public	filterByNumber(set: Set<TPN>, propertiesMap: Map<string, numberExpressionObject>): Set<TPN> Filter the set based on string properties
public	filterByString(set: Set<TPN>, propertiesMap: Map<string, string\|string[]>): Set<TPN> Filter the set based on string properties
public	filterDefaultBooleanProperties(searchObject: searchParameters): Map<string, boolean> Provides a map with valid default properties
public	filterDefaultNumberProperties(searchObject: searchParameters): Map<string, numberExpressionObject> Provides a map with valid default properties
public	filterDefaultStringProperties(searchObject: searchParameters): Map<string, string\|string[]> Provides a map with valid default properties
public	filterMoviesByProperties(searchParameters: searchParameters, allMovies: Set<TPN_Extended>): Set<TPN> Filter the movies based on search parameters
public	filterTvSeriesByProperties(searchParameters: searchParameters, allTvSeries: Map<string, Set<TPN>>): Map<string, Set<TPN>> Filter the tv series based on search parameters

Static Public

public convertToValidExpression(param: number | numberSearchSyntax): Object source

import {convertToValidExpression} from 'torrent-files-library/src/filters/filterNumberProperty.js'

Convert the param to valid expression object for filter function

Params:

Name	Type	Attribute	Description
param	number \| numberSearchSyntax		The param to be converted

Return:

Object

If valid, returns a object. If not, returns undefined

Return Properties:

Name	Type	Attribute	Description
operator	string		The operator for matching process
number	number		The extracted number for matching process

Example:

// returns { operator: '==' , number: 5 }
convertToValidExpression(5);

// returns { operator: '>=' , number: 5 }
convertToValidExpression(">5");

// returns undefined
convertToValidExpression(undefined);

public excludeDefaultBooleanProperties(searchObject: searchParameters): searchParameters source

import {excludeDefaultBooleanProperties} from 'torrent-files-library/src/filters/filterBooleanProperty.js'

Remove the default boolean properties

Params:

Name	Type	Attribute	Description
searchObject	searchParameters		search parameters

Return:

searchParameters

searchParameters without these properties

public excludeDefaultNumberProperties(searchObject: searchParameters): searchParameters source

import {excludeDefaultNumberProperties} from 'torrent-files-library/src/filters/filterNumberProperty.js'

Remove the default number properties

Params:

Name	Type	Attribute	Description
searchObject	searchParameters		search parameters

Return:

searchParameters

searchParameters without these properties

public excludeDefaultStringProperties(searchObject: searchParameters): searchParameters source

import {excludeDefaultStringProperties} from 'torrent-files-library/src/filters/filterStringProperty.js'

Remove the default string properties

Params:

Name	Type	Attribute	Description
searchObject	searchParameters		search parameters

Return:

searchParameters

searchParameters without these properties

public filterByBoolean(set: Set<TPN>, propertiesMap: Map<string, boolean>): Set<TPN> source

import {filterByBoolean} from 'torrent-files-library/src/filters/filterBooleanProperty.js'

Filter the set based on boolean properties

Params:

Name	Type	Attribute	Description
set	Set<TPN>		The TPN set
propertiesMap	Map<string, boolean>		The map from filterDefaultBooleanProperties

Return:

Set<TPN>

the filtered set

public filterByNumber(set: Set<TPN>, propertiesMap: Map<string, numberExpressionObject>): Set<TPN> source

import {filterByNumber} from 'torrent-files-library/src/filters/filterNumberProperty.js'

Filter the set based on string properties

Params:

Name	Type	Attribute	Description
set	Set<TPN>		The TPN set
propertiesMap	Map<string, numberExpressionObject>		The map from filterDefaultStringProperties

Return:

Set<TPN>

the filtered set

public filterByString(set: Set<TPN>, propertiesMap: Map<string, string|string[]>): Set<TPN> source

import {filterByString} from 'torrent-files-library/src/filters/filterStringProperty.js'

Filter the set based on string properties

Params:

Name	Type	Attribute	Description
set	Set<TPN>		The TPN set
propertiesMap	Map<string, string\|string[]>		The map from filterDefaultStringProperties

Return:

Set<TPN>

the filtered set

public filterDefaultBooleanProperties(searchObject: searchParameters): Map<string, boolean> source

import {filterDefaultBooleanProperties} from 'torrent-files-library/src/filters/filterBooleanProperty.js'

Provides a map with valid default properties

Params:

Name	Type	Attribute	Description
searchObject	searchParameters		search parameters

Return:

Map<string, boolean>

the result map

public filterDefaultNumberProperties(searchObject: searchParameters): Map<string, numberExpressionObject> source

import {filterDefaultNumberProperties} from 'torrent-files-library/src/filters/filterNumberProperty.js'

Provides a map with valid default properties

Params:

Name	Type	Attribute	Description
searchObject	searchParameters		search parameters

Return:

Map<string, numberExpressionObject>

the result map

public filterDefaultStringProperties(searchObject: searchParameters): Map<string, string|string[]> source

import {filterDefaultStringProperties} from 'torrent-files-library/src/filters/filterStringProperty.js'

Provides a map with valid default properties

Params:

Name	Type	Attribute	Description
searchObject	searchParameters		search parameters

Return:

Map<string, string|string[]>

the result map

public filterMoviesByProperties(searchParameters: searchParameters, allMovies: Set<TPN_Extended>): Set<TPN> source

import {filterMoviesByProperties} from 'torrent-files-library/src/filters/filterProperties.js'

Filter the movies based on search parameters

Params:

Name	Type	Attribute	Description
searchParameters	searchParameters		search parameters.
allMovies	Set<TPN_Extended>		the movies set

Return:

Set<TPN>

the filtered movie set

public filterTvSeriesByProperties(searchParameters: searchParameters, allTvSeries: Map<string, Set<TPN>>): Map<string, Set<TPN>> source

import {filterTvSeriesByProperties} from 'torrent-files-library/src/filters/filterProperties.js'

Filter the tv series based on search parameters

Params:

Name	Type	Attribute	Description
searchParameters	searchParameters		search parameters.
allTvSeries	Map<string, Set<TPN>>		the tvSeries map

Return:

Map<string, Set<TPN>>

the filtered tvSeries map