fix(fast-element): export missing elements filter helper (#3331)

* fix(fast-element): export missing elements filter helper * doc(fast-element): add api doc update * fix(fast-element): add public dist tag to elements helper Co-authored-by: Nicholas Rice <[email protected]>
microsoft · Jun 17, 2020 · 46de565 · 46de565
1 parent fc258fd
commit 46de565
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/packages/web-components/fast-element/docs/api-report.md b/packages/web-components/fast-element/docs/api-report.md
@@ -221,6 +221,9 @@ export const DOM: Readonly<{
     setBooleanAttribute(element: HTMLElement, attributeName: string, value: boolean): void;
 }>;
 
+// @public
+export function elements(tagName?: string): (value: Node, index: number, array: Node[]) => boolean;
+
 // @public
 export abstract class ElementStyles {
     // @internal (undocumented)

diff --git a/packages/web-components/fast-element/src/directives/node-observation.ts b/packages/web-components/fast-element/src/directives/node-observation.ts
@@ -23,8 +23,9 @@ export interface NodeBehaviorBehaviorOptions<T = any> {
 }
 
 /**
- * Filters an array of nodes to only elements.
+ * Creates a function that can be used to filter a Node array, selecting only elements.
  * @param tagName - An optional tag name to restrict the filter to.
+ * @public
  */
 export function elements(tagName?: string) {
     if (tagName) {

diff --git a/packages/web-components/fast-element/src/index.ts b/packages/web-components/fast-element/src/index.ts
@@ -18,3 +18,4 @@ export * from "./directives/when";
 export * from "./directives/repeat";
 export * from "./directives/slotted";
 export * from "./directives/children";
+export { elements } from "./directives/node-observation";