sfdx-typegen
Type generation from SFDX project
$ npm install -g sfdx-typegen$ sfdx COMMANDrunning 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 COMMANDrunning 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]sfdx typegen:aura:helper [-f <string>] [-o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx typegen:aura:lwc [-f <string>] [-o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
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]sfdx typegen:aura:helper [-f <string>] [-o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
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