INFO

This API documentation is for FAKE version 5.0 or later. The old API documentation can be found here for migration or here for fake 4

This is part of the Fake.JavaScript.Yarn module.

Yarn

Helpers for running the yarn tool

Sample

1: 
2: 
3: 
4: 
Yarn.install (fun o ->
                { o with
                    WorkingDirectory = "./src/FAKESimple.Web/"
                })

Nested types and modules

TypeDescription
InstallArgs

Arguments for the Yarn install command

YarnCommand

The list of supported Yarn commands. The Custom alternative can be used for other commands not in the list until they are implemented

YarnParams

The Yarn parameter type

Functions and values

Function or valueDescription
defaultYarnParams
Signature: YarnParams

Yarn default parameters

exec(command setParams)
Signature: command:string -> setParams:(YarnParams -> YarnParams) -> unit

Run yarn <command>

Parameters

  • 'setParams' - set command parameters

    Sample

    Yarn.exec "someCommand" (fun o -> { o with WorkingDirectory = "./src/FAKESimple.Web/" })

install(setParams)
Signature: setParams:(YarnParams -> YarnParams) -> unit

Run yarn install

Parameters

  • 'setParams' - set command parameters

    Sample

    Yarn.install (fun o -> { o with WorkingDirectory = "./src/FAKESimple.Web/" })

installFlat(setParams)
Signature: setParams:(YarnParams -> YarnParams) -> unit

Run yarn install --flat

Parameters

  • 'setParams' - set command parameters

    Sample

    Yarn.installFlat (fun o -> { o with WorkingDirectory = "./src/FAKESimple.Web/" })

installForced(setParams)
Signature: setParams:(YarnParams -> YarnParams) -> unit

Run yarn install --force

Parameters

  • 'setParams' - set command parameters

    Sample

    Yarn.installForced (fun o -> { o with WorkingDirectory = "./src/FAKESimple.Web/" })

installHar(setParams)
Signature: setParams:(YarnParams -> YarnParams) -> unit

Run yarn install --har

Parameters

  • 'setParams' - set command parameters

    Sample

    Yarn.installHar (fun o -> { o with WorkingDirectory = "./src/FAKESimple.Web/" })

installNoLock(setParams)
Signature: setParams:(YarnParams -> YarnParams) -> unit

Run yarn install --no-lockfile

Parameters

  • 'setParams' - set command parameters

    Sample

    Yarn.installNoLock (fun o -> { o with WorkingDirectory = "./src/FAKESimple.Web/" })

installProduction(setParams)
Signature: setParams:(YarnParams -> YarnParams) -> unit

Run yarn install --production

Parameters

  • 'setParams' - set command parameters

    Sample

    Yarn.installProduction (fun o -> { o with WorkingDirectory = "./src/FAKESimple.Web/" })

installPureLock(setParams)
Signature: setParams:(YarnParams -> YarnParams) -> unit

Run yarn install --pure-lockfile

Parameters

  • 'setParams' - set command parameters

    Sample

    Yarn.installPureLock (fun o -> { o with WorkingDirectory = "./src/FAKESimple.Web/" })