miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity
nx/docs/generated/devkit/createProjectGraphAsync.md
Juri Strumpflohner b51676a89a
docs(core): restructure guides into technologies sections (#31288) 
Updates the docs structure, navigation etc to be easier + better suited
for showing Nx technology support beyond just TS.

**Notes:**

- API (`/nx-api`) tab is removed from the navigation (i.e. menu bar),
but pages still remain for now until we update references in `*.md`
files.
- Redirects are set up `/nx-api` to go to their respect new location
e.g. `/technologies` or `/reference/core-api`
- Old URLs still exist in the sitemap for now, but majority of them will
be redirected -- a follow-up PR can remove them.

**Preview:**
https://nx-dev-git-nx-dev-polyglot-docs-restructure-nrwl.vercel.app/docs

---------

Co-authored-by: Jack Hsu <jack.hsu@gmail.com>
2025-05-29 14:55:34 -04:00

1.4 KiB
Raw Permalink Blame History

Function: createProjectGraphAsync

▸ createProjectGraphAsync(opts?): Promise<ProjectGraph>

Computes and returns a ProjectGraph.

Nx will compute the graph either in a daemon process or in the current process.

Nx will compute it in the current process if:

  • The process is running in CI (CI env variable is to true or other common variables used by CI providers are set).
  • It is running in the docker container.
  • The daemon process is disabled because of the previous error when starting the daemon.
  • NX_DAEMON is set to false.
  • useDaemonProcess is set to false in the options of the tasks runner inside nx.json

NX_DAEMON env variable takes precedence:

  • If it is set to true, the daemon will always be used.
  • If it is set to false, the graph will always be computed in the current process.

Tip: If you want to debug project graph creation, run your command with NX_DAEMON=false.

Nx uses two layers of caching: the information about explicit dependencies stored on the disk and the information stored in the daemon process. To reset both run: nx reset.

Parameters

Name Type
opts Object
opts.exitOnError boolean
opts.resetDaemonClient? boolean

Returns

Promise<ProjectGraph>