docs: add operator flag to operator functions (#6563)

ReactiveX · Oct 6, 2021 · 861aa92 · 861aa92
1 parent d837ee7
commit 861aa92
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 1 deletion.
diff --git a/docs_app/src/styles/2-modules/_label.scss b/docs_app/src/styles/2-modules/_label.scss
@@ -56,6 +56,10 @@ label.raised, .api-header label {
             &.impure-pipe {
                 background-color: $brightred;
             }
+
+            &.operator {
+                background-color: $brightred;
+            }
         }
 
         &.api-type-label {
@@ -69,4 +73,4 @@ label.raised, .api-header label {
 
         }
     }
-}
+}
diff --git a/docs_app/tools/transforms/angular-base-package/index.js b/docs_app/tools/transforms/angular-base-package/index.js
@@ -36,6 +36,7 @@ module.exports = new Package('angular-base', [
   .processor(require('./processors/fixInternalDocumentLinks'))
   .processor(require('./processors/copyContentAssets'))
   .processor(require('./processors/renderLinkInfo'))
+  .processor(require('./processors/checkOperator'))
 
   // overrides base packageInfo and returns the one for the 'angular/angular' repo.
   .factory('packageInfo', function () {

diff --git a/docs_app/tools/transforms/angular-base-package/processors/checkOperator.js b/docs_app/tools/transforms/angular-base-package/processors/checkOperator.js
@@ -0,0 +1,11 @@
+module.exports = function checkOperator() {
+  return {
+    $runAfter: ['generateApiListDoc'],
+    $runBefore: ['renderDocsProcessor'],
+    $process(docs) {
+      docs.forEach((doc) => {
+        doc.isOperator = !!(doc.originalModule && doc.originalModule.startsWith('internal/operators'));
+      });
+    },
+  };
+};
diff --git a/docs_app/tools/transforms/templates/api/base.template.html b/docs_app/tools/transforms/templates/api/base.template.html
@@ -26,6 +26,7 @@ <h1>{$ doc.name $}</h1>
     {% if doc.experimental !== undefined %}<label class="api-status-label experimental">experimental</label>{% endif %}
     {% if doc.stable !== undefined %}<label class="api-status-label stable">stable</label>{% endif %}
     {% if doc.pipeOptions.pure === 'false' %}<label class="api-status-label impure-pipe">impure</label>{% endif %}
+    {% if doc.isOperator %}<label class="api-status-label operator">operator</label>{% endif %}
   </header>
   <aio-toc class="embedded"></aio-toc>