UNPKG

1.77 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright (c) 2017 The Polymer Project Authors. All rights reserved.
4 * This code may only be used under the BSD style license found at
5 * http://polymer.github.io/LICENSE.txt
6 * The complete set of authors may be found at
7 * http://polymer.github.io/AUTHORS.txt
8 * The complete set of contributors may be found at
9 * http://polymer.github.io/CONTRIBUTORS.txt
10 * Code distributed by Google as part of the polymer project is also
11 * subject to an additional IP rights grant found at
12 * http://polymer.github.io/PATENTS.txt
13 */
14import { Document, Feature, JsAstNode, Property, Resolvable, ScannedProperty, SourceRange, Warning } from '../model/model';
15import { Annotation as JsDocAnnotation } from './jsdoc';
16/**
17 * The metadata for a JavaScript namespace.
18 */
19export declare class ScannedNamespace implements Resolvable {
20 name: string;
21 description?: string;
22 summary?: string;
23 jsdoc?: JsDocAnnotation;
24 sourceRange: SourceRange;
25 astNode: JsAstNode;
26 warnings: Warning[];
27 properties: Map<string, ScannedProperty>;
28 constructor(name: string, description: string, summary: string, astNode: JsAstNode, properties: Map<string, ScannedProperty>, jsdoc: JsDocAnnotation, sourceRange: SourceRange);
29 resolve(_document: Document): Namespace;
30}
31declare module '../model/queryable' {
32 interface FeatureKindMap {
33 'namespace': Namespace;
34 }
35}
36export declare class Namespace implements Feature {
37 name: string;
38 description?: string;
39 summary?: string;
40 kinds: Set<string>;
41 identifiers: Set<string>;
42 sourceRange: SourceRange;
43 astNode: JsAstNode;
44 warnings: Warning[];
45 readonly properties: Map<string, Property>;
46 constructor(scannedNamespace: ScannedNamespace);
47 toString(): string;
48}