# @h8try/temporal-nestjs
> temporal for nestjs framework
Latest version **1.0.0** (published 2022-10-31) · ISC license · 0 weekly downloads
## Install
```sh
npm install @h8try/temporal-nestjs
pnpm add @h8try/temporal-nestjs
yarn add @h8try/temporal-nestjs
bun add @h8try/temporal-nestjs
```
## Health
**Score 25/100 (F)** — status: abandoned.
Positive: has types; no vulnerabilities; high quality score.
Warnings: low downloads; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-10-31 |
| First published | 2022-10-31 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 66.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Author | zegue |
| Maintainers | sabarim |
## Links
- npm: https://www.npmjs.com/package/@h8try/temporal-nestjs
- npm.io page: https://npm.io/package/@h8try/temporal-nestjs
## Dependencies (1)
- [release-it](https://npm.io/package/release-it.md) ^14.12.5
## Recent versions
- 1.0.0 (latest) — 2022-10-31
## README
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
A progressive Node.js framework for building efficient and scalable server-side applications.
# nestjs-temporal
[Temporal](https://github.com/temporalio/sdk-typescript) module for [Nest](https://github.com/nestjs/nest).
## Quick start
```ts
import { Module } from '@nestjs/common';
import { TemporalModule } from 'nestjs-temporal';
@Module({
imports: [
TemporalModule.forRoot({
taskQueue: 'default',
workflowsPath: require.resolve('./temporal/workflow'),
}),
TemporalModule.registerClient(),
],
})
export class AppModule {}
```
```ts
import { Injectable } from '@nestjs/common';
import { Activities, Activity } from 'nestjs-temporal';
import { ActivityInterface } from '@temporalio/activity';
@Injectable()
@Activities()
export class GreetingActivity {
constructor() {}
@Activity()
async greeting(name: string): Promise {
return 'Hello ' + name;
}
}
export interface IGreetingActivity extends ActivityInterface {
greeting(name: string): Promise;
}
```
```ts
import { proxyActivities } from '@temporalio/workflow';
// Only import the activity types
import { IGreetingActivity } from '../activities';
const { greeting, reverseGreeting } = proxyActivities({
startToCloseTimeout: '1 minute',
});
export async function example(name: string): Promise {
return await greeting(name);
}
```
```ts
import { Controller, Post } from '@nestjs/common';
import { Connection, WorkflowClient } from '@temporalio/client';
import { InjectTemporalClient } from 'nestjs-temporal';
@Controller()
export class AppController {
constructor(
@InjectTemporalClient() private readonly temporalClient: WorkflowClient,
) {}
@Post()
async greeting() {
const handle = await this.temporalClient.start('example', {
args: ['Temporal'],
taskQueue: 'default',
workflowId: 'wf-id-' + Math.floor(Math.random() * 1000),
});
console.log(`Started workflow ${handle.workflowId}`);
}
}
```
## Advanced Options
```ts
import { Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { TemporalModule } from 'nestjs-temporal';
import { bundleWorkflowCode, NativeConnection, Runtime } from '@temporalio/worker';
import * as path from 'path';
@Module({
imports: [
TempModule.forRootAsync({
imports: [ConfigModule],
inject: [ConfigService],
useFactory: async (config: ConfigService) => {
Runtime.install({});
const temporalHost = config.get('app.temporalHost');
const connection = await NativeConnection.connect({
address: temporalHost,
});
const workflowBundle = await bundleWorkflowCode({
workflowsPath: path.join(__dirname, './workflows'),
});
return {
connection,
taskQueue: 'default',
workflowBundle,
};
},
}),
],
})
export class AppModule {}
```
## People
- Author - [Zegue kurt](https://github.com/KurtzL)
- Contributor - [Surya Prashanth](https://github.com/Prashant-Surya)
- Contributor - [AmirSaber Sharifi](https://github.com/amirsaber)
- Contributor - [J.D Nicholls](https://github.com/jdnichollsc)
## License
Nest is [MIT licensed](https://github.com/KurtzL/nestjs-temporal/blob/main/LICENCE).
---
_Source: https://npm.io/package/@h8try/temporal-nestjs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._