1. Advisor
  2. @electron/docs-parser
  3. @electron/docs-parser code examples
View all @electron/docs-parser analysis

How to use @electron/docs-parser - 7 common examples

To help you get started, we’ve selected a few @electron/docs-parser examples, based on popular ways it is used in public projects.

Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.

github electron / typescript-definitions / src / module-declaration.ts View on Github external
.forEach(prop => {
        const isOptional = !prop.required ? '?' : '';
        const isReadonly = prop.additionalTags.includes(DocumentationTag.AVAILABILITY_READONLY)
          ? 'readonly '
          : '';
        moduleAPI.push(`${isReadonly}${prop.name}${isOptional}: ${utils.typify(prop)};`);
      });
  }
github electron / typescript-definitions / src / utils.ts View on Github external
.map(tag => {
          switch (tag) {
            case DocumentationTag.STABILITY_DEPRECATED:
              return ' * @deprecated';
            case DocumentationTag.STABILITY_EXPERIMENTAL:
              return ' * @experimental';
            case DocumentationTag.OS_LINUX:
              nodePlatforms.push('linux');
              break;
            case DocumentationTag.OS_MACOS:
              nodePlatforms.push('darwin');
              break;
            case DocumentationTag.OS_MAS:
              nodePlatforms.push('mas');
              break;
            case DocumentationTag.OS_WINDOWS:
              nodePlatforms.push('win32');
              break;
          }
          return '';
        })
        .filter(tag => tag),
github electron / typescript-definitions / src / utils.ts View on Github external
.map(tag => {
          switch (tag) {
            case DocumentationTag.STABILITY_DEPRECATED:
              return ' * @deprecated';
            case DocumentationTag.STABILITY_EXPERIMENTAL:
              return ' * @experimental';
            case DocumentationTag.OS_LINUX:
              nodePlatforms.push('linux');
              break;
            case DocumentationTag.OS_MACOS:
              nodePlatforms.push('darwin');
              break;
            case DocumentationTag.OS_MAS:
              nodePlatforms.push('mas');
              break;
            case DocumentationTag.OS_WINDOWS:
              nodePlatforms.push('win32');
              break;
          }
          return '';
        })
        .filter(tag => tag),
github electron / typescript-definitions / src / utils.ts View on Github external
.map(tag => {
          switch (tag) {
            case DocumentationTag.STABILITY_DEPRECATED:
              return ' * @deprecated';
            case DocumentationTag.STABILITY_EXPERIMENTAL:
              return ' * @experimental';
            case DocumentationTag.OS_LINUX:
              nodePlatforms.push('linux');
              break;
            case DocumentationTag.OS_MACOS:
              nodePlatforms.push('darwin');
              break;
            case DocumentationTag.OS_MAS:
              nodePlatforms.push('mas');
              break;
            case DocumentationTag.OS_WINDOWS:
              nodePlatforms.push('win32');
              break;
          }
          return '';
        })
        .filter(tag => tag),
github electron / typescript-definitions / src / utils.ts View on Github external
.map(tag => {
          switch (tag) {
            case DocumentationTag.STABILITY_DEPRECATED:
              return ' * @deprecated';
            case DocumentationTag.STABILITY_EXPERIMENTAL:
              return ' * @experimental';
            case DocumentationTag.OS_LINUX:
              nodePlatforms.push('linux');
              break;
            case DocumentationTag.OS_MACOS:
              nodePlatforms.push('darwin');
              break;
            case DocumentationTag.OS_MAS:
              nodePlatforms.push('mas');
              break;
            case DocumentationTag.OS_WINDOWS:
              nodePlatforms.push('win32');
              break;
          }
          return '';
        })
        .filter(tag => tag),
github electron / typescript-definitions / src / utils.ts View on Github external
.map(tag => {
          switch (tag) {
            case DocumentationTag.STABILITY_DEPRECATED:
              return ' * @deprecated';
            case DocumentationTag.STABILITY_EXPERIMENTAL:
              return ' * @experimental';
            case DocumentationTag.OS_LINUX:
              nodePlatforms.push('linux');
              break;
            case DocumentationTag.OS_MACOS:
              nodePlatforms.push('darwin');
              break;
            case DocumentationTag.OS_MAS:
              nodePlatforms.push('mas');
              break;
            case DocumentationTag.OS_WINDOWS:
              nodePlatforms.push('win32');
              break;
          }
github electron / typescript-definitions / src / utils.ts View on Github external
.map(tag => {
          switch (tag) {
            case DocumentationTag.STABILITY_DEPRECATED:
              return ' * @deprecated';
            case DocumentationTag.STABILITY_EXPERIMENTAL:
              return ' * @experimental';
            case DocumentationTag.OS_LINUX:
              nodePlatforms.push('linux');
              break;
            case DocumentationTag.OS_MACOS:
              nodePlatforms.push('darwin');
              break;
            case DocumentationTag.OS_MAS:
              nodePlatforms.push('mas');
              break;
            case DocumentationTag.OS_WINDOWS:
              nodePlatforms.push('win32');
              break;
          }
          return '';
        })

@electron/docs-parser

Parse Electron documentation into a machine readable JSON file

GitHub
MIT
Latest version published 7 months ago

Package Health Score

65 / 100
Full package analysis

Popular @electron/docs-parser functions

Similar packages