2020-10-05 02:33:12 -07:00
---
id: node
title: Node
sidebar_label: Node
---
## What
2022-05-04 16:46:06 -07:00
Display the currently active [Node.js][node-js] version.
2020-10-05 02:33:12 -07:00
## Sample Configuration
2023-06-26 00:57:27 -07:00
import Config from "@site/src/components/Config.js";
2023-03-31 11:55:36 -07:00
2023-06-26 00:57:27 -07:00
<Config
data={{
type: "node",
style: "powerline",
powerline_symbol: "\uE0B0",
foreground: "#ffffff",
background: "#6CA35E",
template: " \uE718 {{ .Full }} ",
}}
/>
2020-10-22 04:47:42 -07:00
## Properties
2023-03-12 23:49:09 -07:00
| Name | Type | Description |
| ----------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the Node.js version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
2022-09-16 07:32:48 -07:00
| `display_mode` | `string` | <ul><li>`always`: The segment is always displayed</li><li>`files`: The segment is only displayed when one of the following files is present (**default**):<ul><li>`*.js`</li><li>`*.ts`</li><li>`package.json`</li><li>`.nvmrc`</li><li>`pnpm-workspace.yaml`</li><li>`.pnpmfile.cjs`</li><li>`.npmrc`</li><li>`.vue`</li></ul></li></ul> |
2023-03-12 23:49:09 -07:00
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `fetch_package_manager` | `boolean` | define if the current project uses Yarn or NPM - defaults to `false` |
| `yarn_icon` | `string` | the icon/text to display when using Yarn - defaults to ` \uF61A` |
| `npm_icon` | `string` | the icon/text to display when using NPM - defaults to ` \uE71E` |
2021-12-03 11:36:30 -08:00
2022-02-01 03:10:46 -08:00
## Template ([info][templates])
:::note default template
2022-09-16 07:32:48 -07:00
```template
2022-02-01 03:10:46 -08:00
{{ if .PackageManagerIcon }}{{ .PackageManagerIcon }} {{ end }}{{ .Full }}
```
:::
### Properties
2021-12-03 11:36:30 -08:00
2022-09-16 07:32:48 -07:00
| Name | Type | Description |
| --------------------- | --------- | ------------------------------------------------------------------- |
| `.Full` | `string` | the full version |
| `.Major` | `string` | major number |
| `.Minor` | `string` | minor number |
| `.Patch` | `string` | patch number |
| `.URL` | `string` | URL of the version info / release notes |
| `.Error` | `string` | error encountered when fetching the version string |
| `.PackageManagerIcon` | `string` | the Yarn or NPM icon when setting `fetch_package_manager` to `true` |
2023-06-26 00:57:27 -07:00
| `.Mismatch` | `boolean` | true if the version in `.nvmrc` is not equal to `.Full` |
2023-03-12 23:49:09 -07:00
| `.Expected` | `string` | the expected version set in `.nvmrc` |
2021-12-03 11:36:30 -08:00
2022-05-16 08:20:03 -07:00
[go-text-template]: https://golang.org/pkg/text/template/
2022-04-20 09:43:59 -07:00
[templates]: /docs/configuration/templates
2022-05-04 16:46:06 -07:00
[node-js]: https://nodejs.org
