build(aio): improve the API Pipe pages (#22702)

This change adds:

* an impure badge for Pipes that are marked as  `pure: false`
* a pipe specific overview that shows the syntax for using a pipe in a template.
* an "input value" section describing the type of the value that the pipe expects.
* a "pipe params" section describing any additional params that a pipe expects.

PR Close #22702
This commit is contained in:
Pete Bacon Darwin
2018-03-11 09:42:49 +00:00
committed by Kara Erickson
parent cd2ebd22fd
commit d509bd6849
10 changed files with 123 additions and 2 deletions

View File

@ -0,0 +1,19 @@
module.exports = function extractPipeParams(createDocMessage) {
return {
$runAfter: ['extractDecoratedClassesProcessor'],
$runBefore: ['docs-processed'],
$process(docs) {
docs.forEach(doc => {
if (doc.docType === 'pipe') {
const transformFn = doc.members && doc.members.find(member => member.name === 'transform');
if (!transformFn) {
throw new Error(createDocMessage('Missing `transform` method - pipes must implement PipeTransform interface', doc));
}
doc.pipeName = doc.pipeOptions.name.replace(/^["']|["']$/g, '');
doc.valueParam = transformFn.parameterDocs[0];
doc.pipeParams = transformFn.parameterDocs.slice(1);
}
});
}
};
};