npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2025 – Pkg Stats / Ryan Hefner

sfdx-typegen

v0.6.2

Published

Type generation for SFDX projects

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

heberheber

Keywords

sfdx-plugin

Readme

sfdx-typegen

Type generation from SFDX project

Version CircleCI Appveyor CI Codecov Greenkeeper Known Vulnerabilities Downloads/week License

$ npm install -g sfdx-typegen
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
sfdx-typegen/0.6.2 win32-x64 node-v10.15.3
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...
$ npm install -g sfdx-typegen
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
sfdx-typegen/0.5.1 win32-x64 node-v10.15.3
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

sfdx typegen:aura:cmp [-f <string>] [-a <string>] [-o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Generate component types that can be used in your controller and helper files to improve auto-complete and correctness

USAGE
  $ sfdx typegen:aura:cmp [-f <string>] [-a <string>] [-o <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -a, --apextypespath=apextypespath                                                 [default: types/apex] Path to typing
                                                                                    directory that holds compatible
                                                                                    types for AuraEnabled properties in
                                                                                    Apex controllers and classes

  -f, --file=file                                                                   [default:
                                                                                    force-app/**/aura/**/*.cmp,force-app
                                                                                    /**/aura/**/*.app] Glob pattern for
                                                                                    cmp files

  -o, --output=output                                                               [default: .sfdx/typings/aura/] Path
                                                                                    to typing output directory,
                                                                                    typically embedded in the project
                                                                                    '.sfdx' directory

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  $ sfdx typegen:cmp --file force-app/**/aura/**/*.cmp
  $ sfdx typegen:cmp --file force-app/**/aura/**/*.cmp --apextypespath types/apex
  $ sfdx typegen:cmp --file force-app/main/default/aura/TestComponent/TestComponent.cmp

See code: lib\commands\typegen\aura\cmp.js

sfdx typegen:aura:helper [-f <string>] [-o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Export types from existing Helper.ts files, should preserve typing information from the functions and properties and export to usable declarations

USAGE
  $ sfdx typegen:aura:helper [-f <string>] [-o <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -f, --file=file                                                                   [default:
                                                                                    force-app/**/aura/**/*Helper.ts]
                                                                                    Glob pattern for helper typescript
                                                                                    files,
                                                                                    [force-app/**/aura/**/*Helper.ts]

  -o, --output=output                                                               [default: .sfdx/typings/aura] Path
                                                                                    to an output destination for
                                                                                    generated d.ts files

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  $ sfdx typegen:helper
  $ sfdx typegen:helper --file force-app/**/aura/**/*Helper.ts
  $ sfdx typegen:helper --file force-app/main/default/aura/TestComponent/TestComponentHelper.cmp

See code: lib\commands\typegen\aura\helper.js

sfdx typegen:aura:lwc [-f <string>] [-o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Generate component types that can be used in your controller and helper files to improve auto-complete and correctness

USAGE
  $ sfdx typegen:aura:lwc [-f <string>] [-o <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -f, --file=file                                                                   [default: force-app/**/lwc/**/*.js]
                                                                                    Glob pattern for cmp files

  -o, --output=output                                                               [default: .sfdx/typings/aura/lwc]
                                                                                    Path to typing output directory,
                                                                                    typically embedded in the project
                                                                                    '.sfdx' directory

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  $ sfdx typegen:aura:lwc
  $ sfdx typegen:aura:lwc --file force-app/**/lwc/**/*.js
  $ sfdx typegen:aura:lwc --file force-app/main/default/lwc/testComponent/testComponent.js

See code: lib\commands\typegen\aura\lwc.js

sfdx typegen:aura:cmp [-f <string>] [-a <string>] [-o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Generate component types that can be used in your controller and helper files to improve auto-complete and correctness

USAGE
  $ sfdx typegen:aura:cmp [-f <string>] [-a <string>] [-o <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -a, --apextypespath=apextypespath                                                 [default: types/apex] Path to typing
                                                                                    directory that holds compatible
                                                                                    types for AuraEnabled properties in
                                                                                    Apex controllers and classes

  -f, --file=file                                                                   [default:
                                                                                    force-app/**/aura/**/*.cmp] Glob
                                                                                    pattern for cmp files

  -o, --output=output                                                               [default: .sfdx/typings/aura/] Path
                                                                                    to typing output directory,
                                                                                    typically embedded in the project
                                                                                    '.sfdx' directory

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  $ sfdx typegen:cmp --file force-app/**/aura/**/*.cmp
  $ sfdx typegen:cmp --file force-app/**/aura/**/*.cmp --apextypespath types/apex
  $ sfdx typegen:cmp --file force-app/main/default/aura/TestComponent/TestComponent.cmp

See code: lib\commands\typegen\aura\cmp.js

sfdx typegen:aura:helper [-f <string>] [-o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Export types from existing Helper.ts files, should preserve typing information from the functions and properties and export to usable declarations

USAGE
  $ sfdx typegen:aura:helper [-f <string>] [-o <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -f, --file=file                                                                   [default:
                                                                                    force-app/**/aura/**/*Helper.ts]
                                                                                    Glob pattern for helper typescript
                                                                                    files,
                                                                                    [force-app/**/aura/**/*Helper.ts]

  -o, --output=output                                                               [default: .sfdx/typings/aura] Path
                                                                                    to an output destination for
                                                                                    generated d.ts files

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  $ sfdx typegen:helper
  $ sfdx typegen:helper --file force-app/**/aura/**/*Helper.ts
  $ sfdx typegen:helper --file force-app/main/default/aura/TestComponent/TestComponentHelper.cmp

See code: lib\commands\typegen\aura\helper.js