Skip to content

Commit 13b3fb8

Browse files
tolyotolyo
committed
Narrow filter function types
1 parent 24f512e commit 13b3fb8

File tree

18 files changed

+53
-22
lines changed

18 files changed

+53
-22
lines changed

‎@types/core/di/ng-module/ng-module.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,10 @@ export class NgModule {
109109
animation(name: string, animationFactory: ng.Injectable<any>): NgModule;
110110
/**
111111
* @param {string} name
112-
* @param {ng.Injectable<ng.FilterFactory>} filterFn
112+
* @param {ng.FilterFactory} filterFn
113113
* @return {NgModule}
114114
*/
115-
filter(name: string, filterFn: ng.Injectable<ng.FilterFactory>): NgModule;
115+
filter(name: string, filterFn: ng.FilterFactory): NgModule;
116116
/**
117117
* The $controller service is used by Angular to create new controllers.
118118
* This provider allows controller registration via the register method.

‎@types/core/filter/filter.d.ts‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,9 @@ export class FilterProvider {
1414
/**
1515
* Register a filter a config phase;
1616
* @param {string} name
17-
* @param {ng.Injectable<ng.FilterFactory>} factory
17+
* @param {ng.FilterFactory} factory
1818
* @return {ng.FilterProvider}
1919
*/
20-
register(
21-
name: string,
22-
factory: ng.Injectable<ng.FilterFactory>,
23-
): ng.FilterProvider;
24-
$get: (string | (($injector: ng.InjectorService) => ng.FilterFactory))[];
20+
register(name: string, factory: ng.FilterFactory): ng.FilterProvider;
21+
$get: (string | (($injector: ng.InjectorService) => ng.FilterService))[];
2522
}

‎@types/filters/interface.d.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,7 @@ export type FilterFn = (input: any, ...args: any[]) => any;
66
* A filter factory function that returns a FilterFn.
77
*/
88
export type FilterFactory = (...args: any[]) => FilterFn;
9+
/**
10+
* A filter service for retrieving filters functions
11+
*/
12+
export type FilterService = (name: string) => FilterFn;

‎@types/interface.d.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ export * from "./services/cookie/interface.ts";
1515
export * from "./services/exception/exception.ts";
1616
export * from "./services/exception/interface.ts";
1717
export * from "./core/parse/interface.ts";
18+
export * from "./filters/interface.ts";
19+
export * from "./core/filter/filter.js";
1820
import { Attributes } from "./core/compile/attributes.js";
1921
import { Scope } from "./core/scope/scope.js";
2022
/**

‎@types/namespace.d.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import { HttpParamSerializer as THttpParamSerializer } from "./services/http/int
2020
import { HttpParamSerializerProvider as THttpParamSerializerProvider } from "./services/http/http.js";
2121
import {
2222
FilterFactory as TFilterFactory,
23+
FilterService as TFilterService,
2324
FilterFn as TFilterFn,
2425
} from "./filters/interface.ts";
2526
import { FilterProvider as TFilterProvider } from "./core/filter/filter.js";
@@ -121,6 +122,7 @@ declare global {
121122
type ExceptionHandlerService = TExceptionHandler;
122123
type FilterFn = TFilterFn;
123124
type FilterFactory = TFilterFactory;
125+
type FilterService = TFilterService;
124126
type HttpParamSerializerSerService = THttpParamSerializer;
125127
type HttpService = THttpService;
126128
type InterpolateService = TInterpolateService;

‎docs/static/typedoc/assets/navigation.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/static/typedoc/assets/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/static/typedoc/classes/FilterProvider.html‎

Lines changed: 9 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/static/typedoc/index.html‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/static/typedoc/types/FilterFactory.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FilterFactory | AngularTS</title><meta name="description" content="Documentation for AngularTS"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">AngularTS</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">FilterFactory</a></li></ul><h1>Type Alias FilterFactory</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">FilterFactory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="FilterFn.html" class="tsd-signature-type tsd-kind-type-alias">FilterFn</a></div><div class="tsd-comment tsd-typography"><p>A filter factory function that returns a FilterFn.</p>
2+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="FilterFn.html" class="tsd-signature-type tsd-kind-type-alias">FilterFn</a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="FilterFn.html" class="tsd-signature-type tsd-kind-type-alias">FilterFn</a></h4></li></ul></li></ul></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">AngularTS</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

0 commit comments

Comments
 (0)