# @backstage/backend-common

> Common functionality library for Backstage backends

Latest version **0.25.0** (published 2024-09-17) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @backstage/backend-common
pnpm add @backstage/backend-common
yarn add @backstage/backend-common
bun add @backstage/backend-common
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.25.0 |
| Published | 2024-09-17 |
| First published | 2020-04-30 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 64 |
| Unpacked size | 648.8 KB |
| Known vulnerabilities | 0 (+13 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 34410 |
| Maintainers | patriko, freben, marcuseide |
| Keywords | backstage |

## Links

- npm: https://www.npmjs.com/package/@backstage/backend-common
- Repository: https://github.com/backstage/backstage
- Homepage: https://backstage.io
- npm.io page: https://npm.io/package/@backstage/backend-common

## Dependencies (64)

- [pg](https://npm.io/package/pg.md) ^8.11.3
- [yn](https://npm.io/package/yn.md) ^4.0.0
- [tar](https://npm.io/package/tar.md) ^6.1.12
- [cors](https://npm.io/package/cors.md) ^2.8.5
- [jose](https://npm.io/package/jose.md) ^5.0.0
- [keyv](https://npm.io/package/keyv.md) ^4.5.2
- [knex](https://npm.io/package/knex.md) ^3.0.0
- [uuid](https://npm.io/package/uuid.md) ^9.0.0
- [luxon](https://npm.io/package/luxon.md) ^3.0.0
- [yauzl](https://npm.io/package/yauzl.md) ^3.0.0
- [helmet](https://npm.io/package/helmet.md) ^6.0.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [morgan](https://npm.io/package/morgan.md) ^1.10.0
- [mysql2](https://npm.io/package/mysql2.md) ^3.0.0
- [express](https://npm.io/package/express.md) ^4.17.1
- [logform](https://npm.io/package/logform.md) ^2.3.2
- [p-limit](https://npm.io/package/p-limit.md) ^3.1.0
- [winston](https://npm.io/package/winston.md) ^3.2.1
- [archiver](https://npm.io/package/archiver.md) ^7.0.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^11.2.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.5
- [raw-body](https://npm.io/package/raw-body.md) ^2.4.1
- [dockerode](https://npm.io/package/dockerode.md) ^4.0.0
- [minimatch](https://npm.io/package/minimatch.md) ^9.0.0
- [pg-format](https://npm.io/package/pg-format.md) ^1.0.4
- [stoppable](https://npm.io/package/stoppable.md) ^1.1.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.7.0
- [node-forge](https://npm.io/package/node-forge.md) ^1.3.1
- [selfsigned](https://npm.io/package/selfsigned.md) ^2.0.0
- [@keyv/redis](https://npm.io/package/@keyv/redis.md) ^2.5.3
- [@types/cors](https://npm.io/package/@types/cors.md) ^2.8.6
- [compression](https://npm.io/package/compression.md) ^1.7.4
- [triple-beam](https://npm.io/package/triple-beam.md) ^1.4.1
- [@types/luxon](https://npm.io/package/@types/luxon.md) ^3.0.0
- [@octokit/rest](https://npm.io/package/@octokit/rest.md) ^19.0.3
- [base64-stream](https://npm.io/package/base64-stream.md) ^1.0.0
- [concat-stream](https://npm.io/package/concat-stream.md) ^2.0.0
- [git-url-parse](https://npm.io/package/git-url-parse.md) ^14.0.0
- [@aws-sdk/types](https://npm.io/package/@aws-sdk/types.md) ^3.347.0
- [@keyv/memcache](https://npm.io/package/@keyv/memcache.md) ^1.3.5
- [@types/express](https://npm.io/package/@types/express.md) ^4.17.6
- [isomorphic-git](https://npm.io/package/isomorphic-git.md) ^1.23.0
- [path-to-regexp](https://npm.io/package/path-to-regexp.md) ^8.0.0
- [@backstage/types](https://npm.io/package/@backstage/types.md) ^1.1.1
- [@types/dockerode](https://npm.io/package/@types/dockerode.md) ^3.3.0
- [@backstage/config](https://npm.io/package/@backstage/config.md) ^1.2.0
- [@backstage/errors](https://npm.io/package/@backstage/errors.md) ^1.2.4
- [winston-transport](https://npm.io/package/winston-transport.md) ^4.5.0
- [@aws-sdk/client-s3](https://npm.io/package/@aws-sdk/client-s3.md) ^3.350.0
- [@types/webpack-env](https://npm.io/package/@types/webpack-env.md) ^1.15.2
- [@backstage/cli-common](https://npm.io/package/@backstage/cli-common.md) ^0.1.14
- [@google-cloud/storage](https://npm.io/package/@google-cloud/storage.md) ^7.0.0
- [@manypkg/get-packages](https://npm.io/package/@manypkg/get-packages.md) ^1.1.3
- [@backstage/integration](https://npm.io/package/@backstage/integration.md) ^1.15.0
- [express-promise-router](https://npm.io/package/express-promise-router.md) ^4.1.0
- [@kubernetes/client-node](https://npm.io/package/@kubernetes/client-node.md) 0.20.0
- [@backstage/config-loader](https://npm.io/package/@backstage/config-loader.md) ^1.9.1
- [@aws-sdk/abort-controller](https://npm.io/package/@aws-sdk/abort-controller.md) ^3.347.0
- [@aws-sdk/client-codecommit](https://npm.io/package/@aws-sdk/client-codecommit.md) ^3.350.0
- [@backstage/plugin-auth-node](https://npm.io/package/@backstage/plugin-auth-node.md) ^0.5.2
- [@backstage/backend-dev-utils](https://npm.io/package/@backstage/backend-dev-utils.md) ^0.1.5
- [@aws-sdk/credential-providers](https://npm.io/package/@aws-sdk/credential-providers.md) ^3.350.0
- [@backstage/backend-plugin-api](https://npm.io/package/@backstage/backend-plugin-api.md) ^1.0.0
- [@backstage/integration-aws-node](https://npm.io/package/@backstage/integration-aws-node.md) ^0.1.12

## Recent versions

- 0.25.0 (latest) — 2024-09-17
- 0.0.0-nightly-20240917021806 (nightly) — 2024-09-17
- 0.25.0-next.2 (next) — 2024-09-10
- 0.0.0-nightly-20240916023337 — 2024-09-16
- 0.0.0-nightly-20240915023307 — 2024-09-15
- 0.0.0-nightly-20240914022633 — 2024-09-14
- 0.0.0-nightly-20240913023025 — 2024-09-13
- 0.0.0-nightly-20240912022955 — 2024-09-12
- 0.0.0-nightly-20240911022723 — 2024-09-11
- 0.0.0-nightly-20240910023018 — 2024-09-10
- 0.0.0-nightly-20240909023012 — 2024-09-09
- 0.0.0-nightly-20240908023050 — 2024-09-08
- 0.0.0-nightly-20240907022659 — 2024-09-07
- 0.0.0-nightly-20240906022905 — 2024-09-06
- 0.0.0-nightly-20240905022851 — 2024-09-05
- … 1332 more at https://npm.io/package/@backstage/backend-common/versions

## README

# @backstage/backend-common

> [!CAUTION]
> This package is deprecated and will be removed in a near future, so please follow the deprecated instructions for the exports you still use.

Common functionality library for Backstage backends, implementing logging,
error handling and similar.

## Usage

Add the library to your backend package:

```bash
# From your Backstage root directory
yarn --cwd packages/backend add @backstage/backend-common
```

then make use of the handlers and logger as necessary:

```typescript
import {
  errorHandler,
  getRootLogger,
  notFoundHandler,
  requestLoggingHandler,
} from '@backstage/backend-common';

const app = express();
app.use(requestLoggingHandler());
app.use('/home', myHomeRouter);
app.use(notFoundHandler());
app.use(errorHandler());

app.listen(PORT, () => {
  getRootLogger().info(`Listening on port ${PORT}`);
});
```

## Documentation

- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
- [Backstage Documentation](https://backstage.io/docs)

---
_Source: https://npm.io/package/@backstage/backend-common · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._