Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

OBSOLETE

FAKE0001 Use the Fake.JavaScript.Npm module instead

NpmHelper

Contains function to run npm tasks

Nested types and modules

TypeDescription
InstallArgs
OBSOLETE

FAKE0001 Use the Fake.JavaScript.Npm module instead

Arguments for the Npm install command

NpmCommand
OBSOLETE

FAKE0001 Use the Fake.JavaScript.Npm module instead

The list of supported Npm commands.

NpmParams
OBSOLETE

FAKE0001 Use the Fake.JavaScript.Npm module instead

The Npm parameter type

Functions and values

Function or valueDescription
defaultNpmParams
Signature: NpmParams
Attributes:
[<Obsolete("FAKE0001 Use the Fake.JavaScript.Npm module instead")>]
OBSOLETE

FAKE0001 Use the Fake.JavaScript.Npm module instead

Npm default parameters

Npm(setParams)
Signature: setParams:(NpmParams -> NpmParams) -> unit
Attributes:
[<Obsolete("FAKE0001 Use the Fake.JavaScript.Npm module instead")>]
OBSOLETE

FAKE0001 Use the Fake.JavaScript.Npm module instead

Runs npm with the given modification function. Make sure to have npm installed, you can install npm with nuget or a regular install. To change which Npm executable to use you can set the NpmFilePath parameter with the setParams function.

Parameters

  • setParams - Function used to overwrite the Npm default parameters.

Sample

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
11: 
12: 
13: 
   Target "Web" (fun _ ->
       Npm (fun p ->
              { p with
                  Command = Install Standard
                  WorkingDirectory = "./src/FAKESimple.Web/"
              })

       Npm (fun p ->
              { p with
                  Command = (Run "build")
                  WorkingDirectory = "./src/FAKESimple.Web/"
              })
   )
npmFileName
Signature: string

Default paths to Npm

parse(_arg1)
Signature: _arg1:NpmCommand -> string
parseInstallArgs(_arg1)
Signature: _arg1:InstallArgs -> string
run(npmParams)
Signature: npmParams:NpmParams -> unit
Attributes:
[<Obsolete("FAKE0001 Use the Fake.JavaScript.Npm module instead")>]
OBSOLETE

FAKE0001 Use the Fake.JavaScript.Npm module instead

Runs the given process and returns the process result.