# Redis ### Imports {% tabs %} {% tab title="Service" %} ```typescript import { RedisService } from 'niro-health'; ``` {% endtab %} {% tab title="Module" %} ```typescript import { RedisModule } from 'niro-health'; ``` {% endtab %} {% tab title="Interface" %} ```typescript import type { IRedisService } from 'niro-health'; ``` {% endtab %} {% endtabs %} ### Environment Variables Do you create variables an `.env` file.

name	description
`REDIS_HOST`	`Host of the redis.`
`REDIS_PORT`	`Port of the redis.`
`REDIS_PASSWORD`	`Password of the redis.`

Check the example file. {% code title=".env" %} ```properties REDIS_HOST=redis://localhost:6379 REDIS_PORT=6379 REDIS_PASSWORD= ``` {% endcode %} ### Method of Use To use this module, you need to inject it into the desired service. {% code overflow="wrap" %} ```typescript import { Module } from '@nestjs/common'; import { AppHostService, PrismaService, ConfigurationService, ValidatorRegexpService, StringExService, DebugService, } from 'niro-health'; import { AppController } from './app.controller'; import { AppService } from './app.service'; @Module({ controllers: [AppController], providers: [ AppService, { provide: 'IAppHostService', useClass: AppHostService, }, { provide: 'IPrismaService', useClass: PrismaService, }, { provide: 'IConfigurationService', useClass: ConfigurationService, }, { provide: 'IValidatorRegexpService', useClass: ValidatorRegexpService, }, { provide: 'IStringExService', useClass: StringExService, }, { provide: 'IDebugService', useClass: DebugService, }, ], }) export class AppModule {} ``` {% endcode %} Injecting the module into our service. ```typescript import { Inject, Injectable } from '@nestjs/common'; import type { IAppHostService, IRedisService } from 'niro-health'; @Injectable() export class AppService { constructor( @Inject('IAppHostService') private readonly appHostService: IAppHostService, @Inject('IRedisService') private readonly redisService: IRedisService, ) {} async enableShutdownHooks() { await this.redisService.enableShutdownHooks(this.appHostService.app); } } ``` Modifying our **`main.ts`** {% code title="main.ts" %} ```typescript import { NestFactory } from '@nestjs/core'; import { AppModule } from '@/app.module'; import { Logger } from '@nestjs/common'; import { AppHostModule, AppHostService } from 'niro-health'; import { AppModule } from './app.module'; import { AppService } from './app.service'; (async function bootstrap() { const app = await NestFactory.create(AppModule, { logger: new Logger('NestApplication', { timestamp: true, }), cors: true, }); app.select(AppHostModule).get(AppHostService).setApp(app); app.select(AppModule).get(AppService).enableShutdownHooks(); })(); ``` {% endcode %} ### With dependencies You will need to inject the following interfaces.

Interface	Service
`AppHostService`	Link to Service documentation
`IConfigurationService`	Link to Service documentation
`IValidatorRegexpService`	Link to Service documentation
`IStringExService`	Link to Service documentation
`IDebugService`	Link to Service documentation

### Properties

Property	Scope	Description
`app`	`public`	`This is instance of application.`
`_client`	`private`	`This is the major component of ioredis. Use it to connect to a standalone Redis server or Sentinels.`
`_redisConfigurationFalsy`	`private`	`This is used to check if the environment variables from Redis are missing.`
get `redisConfigurationFalsy`	`public`	`Returns if environment variables from Redis are missing.`

### Methods

Method	Scope	Description
`keys`	`public`	`Get all keys that match a pattern.`
`save`	`public`	`It saves a key-value pair in the Redis database.`
`saveBuffer`	`public`	`It saves a key-value pair in the Redis database.`
`update`	`public`	`It update a key-value pair in the Redis database.`
`updateBuffer`	`public`	`It update a key-value pair in the Redis database.`
`findAll`	`public`	`It returns all the values in the Redis database.`
`findOne`	`public`	`It returns a value in the Redis database.`
`delete`	`public`	`It delete a key-value pair in the Redis database.`
`flushall`	`public`	`Delete all the keys of all the existing databases, not just the currently selected one.`
`shutdown`	`public`	`This method is used to shutdown application.`
`onApplicationShutdown`	`public`	`Application shutdown hook.`
`enableShutdownHooks`	`public`	`Enable shutdown hooks.`

--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://guilhermesantos.gitbook.io/niro-health/modules/core/redis.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.