\n\n\n\n## Getting started\n\nTo set up or update an Angular project with this library use the Angular CLI's [schematic][schematics] commands:\n\n#### Installation\n\n```sh\nng add @hug/ngx-sentry\n```\n\n\n More details\n\n> \n>\n> The `ng add` command will ask you the following questions:\n>\n> 1. **Name of the project in Sentry**: *the name used when creating the Sentry project*\n> 2. **Data Source Name (DSN) url**: *the url provided during the Sentry project creation process*\n>\n> And will also perform the following actions:\n>\n> - Create a `.sentryclirc` file containing all the Sentry configurations\n> - Initialize and configure Sentry in `main.ts`\n> - Add `resolveJsonModule` and `allowSyntheticDefaultImports` to `tsconfig.json`\n> - Import the `NgxSentryModule` in your Angular application module (if app is not standalone)\n\n\n\n#### Update\n\n```sh\nng update @hug/ngx-sentry\n```\n\n\n## Usage\n\nFollow these steps to integrate your project's source maps with Sentry:\n\n1. Generate Source Maps\n ```sh\n ng build --source-map\n ```\n\n2. Provide Source Maps to Sentry\n ```sh\n npx ngx-sentry ./project-dist-path\n ```\n\n\n## Options\n\nThis library is a wrapper around the official [Sentry JavaScript SDK][sentry-sdk-url] with extra functionalities and configurations.\n\nAll options available in `@sentry/browser` can be configured from `@hug/ngx-sentry`.\n\nYou shouldn't have to configure anything else but in case you wanted to, you can still do it.\n\n#### Sentry Browser's SDK\n\nThe Sentry Browser's SDK can be configured in `main.ts`:\n\n```ts\ninitSentry(options: BrowserOptions);\n```\n\n#### Error handler\n\nThe behavior of the error handler can be configured either in:\n\n* `main.ts` *(if the app is a standalone Angular application)*\n ```ts\n bootstrapApplication(AppComponent, {\n providers: [\n provideSentry(options?: ErrorHandlerOptions)\n ]\n });\n ```\n\n* `app.module.ts` *(if the app is **not** a standalone Angular application)*\n ```ts\n @NgModule({\n imports: [\n NgxSentryModule.forRoot(options?: ErrorHandlerOptions)\n ]\n })\n export class AppModule { }\n ```\n\n#### Current user\n\nYou can define the current user via the `setSentryUser()` api:\n\n```ts\n// import { setSentryUser } from '@hug/ngx-sentry/standalone';\n// import { setSentryUser } from '@hug/ngx-sentry';\n\npublic ngOnInit(): void {\n // Set the current user\n setSentryUser({\n email: 'rtrm@hcuge.ch',\n username: 'rtrm',\n attr1: 'attr1'\n });\n\n // Remove the current user\n setSentryUser(null);\n}\n```\n\n## Development\n\nSee the [developer docs][developer].\n\n\n## Contributing\n\n#### > Want to Help?\n\nWant to file a bug, contribute some code or improve documentation? Excellent!\n\nBut please read up first on the guidelines for [contributing][contributing], and learn about submission process, coding rules and more.\n\n#### > Code of Conduct\n\nPlease read and follow the [Code of Conduct][codeofconduct], and help us keep this project open and inclusive.\n\n\n## Credits\n\nCopyright (C) 2021 [HUG - Hôpitaux Universitaires Genève][dsi-hug]\n\n[][dsi-hug]\n\n\n\n\n[schematics]: https://angular.io/guide/schematics-for-libraries\n[sentry-sdk-url]: https://github.com/getsentry/sentry-javascript\n[developer]: https://github.com/dsi-hug/ngx-sentry/blob/main/DEVELOPER.md\n[contributing]: https://github.com/dsi-hug/ngx-sentry/blob/main/CONTRIBUTING.md\n[codeofconduct]: https://github.com/dsi-hug/ngx-sentry/blob/main/CODE_OF_CONDUCT.md\n[dsi-hug]: https://github.com/dsi-hug\n","readmeFilename":"README.md"}
![\"hug-logo\"](\"https://cdn.hug.ch/svgs/hug/hug-logo-horizontal.svg\"){kind=logo}
\n \n ![\"npm](\"https://img.shields.io/npm/v/@hug/ngx-sentry.svg?color=blue&logo=npm\")
![\"npm](\"https://img.shields.io/npm/dw/@hug/ngx-sentry.svg?color=blue&logo=npm\")
![\"license](\"https://img.shields.io/badge/license-GPLv3-ff69b4.svg\"){kind=icon}
![\"build](\"https://github.com/dsi-hug/ngx-sentry/actions/workflows/ci_tests.yml/badge.svg\"){kind=icon}
![\"PRs](\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg\"){kind=icon}