Home Manual Reference Source Test

References

summary
public	C TorrentLibrary Class representing the TorrentLibrary
public	E EventEmitter
public	E Promise A promise object provided by the bluebird promise library.
public	E nameParser: customParsingFunction Default Parser for media files name

docs/events

summary
public	T Events#addNewPath: Object addNewPath event
public	T Events#error_in_function: Object error_in_function event
public	T Events#missing_parameter: Object missing_parameter event
public	T Events#removeOldFiles: object removeOldFiles event
public	T Events#scan: object scan event

docs/types

summary
public	T StorageVar: Set<TPN_Extended>\|Map<string, Set<TPN_Extended> The sub way to store all kind of media files found in paths
public	T StoreVar: Map<string, StorageVar> The master variable where we store all kind of media files found in paths
public	T TPN: Object The result of parsing file name
public	T TPN_Extended: TPN The extended TPN object
public	T additionalProperties: Object allows user to provide custom filtering stuff
public	T customParsingFunction(title: string): TPN: Function A parsing function to be used with this lib
public	T numberExpressionObject: Object Number expression for number filtering
public	T numberSearchSyntax: string The search syntax for number properties : a operator follows by a number
public	T searchParameters: Object search parameters object

filters

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

Directories