UNPKG

1.07 kBSource Map (JSON)View Raw
1{"version":3,"file":"IYamlTocFile.js","sourceRoot":"","sources":["../../src/yaml/IYamlTocFile.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n/**\n * A node in the navigation hierarchy for the table of contents.\n */\nexport interface IYamlTocItem {\n /**\n * The title to display\n */\n name: string;\n\n /**\n * If specified, the hyperlink will point to the API with this UID\n */\n uid?: string;\n\n /**\n * IF specified, the hyperlink will point to this URL, which may be a relative URL path\n */\n href?: string;\n\n /**\n * Child nodes in the hierarchy\n */\n items?: IYamlTocItem[];\n}\n\n/**\n * TypeScript interface describing the toc.yml file format, used to represent\n * the table of contents for a Universal Reference YAML documentation file.\n */\nexport interface IYamlTocFile {\n items: IYamlTocItem[];\n metadata?: { [key: string]: string };\n}\n"]}
\No newline at end of file