https://github.com/henriquealbert/meteor-settings-validator

https://github.com/henriquealbert/meteor-settings-validator

Last synced: 18 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/henriquealbert/meteor-settings-validator
• Owner: henriquealbert
• Created: 2023-12-01T15:33:00.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-02-26T16:05:09.000Z (8 months ago)
• Last Synced: 2024-10-09T09:31:01.186Z (28 days ago)
• Language: TypeScript
• Size: 46.9 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Meteor Settings Validator

The `MeteorSettingsValidator` class simplifies the validation of Meteor.settings using a specified Zod schema. This utility ensures that the settings adhere to the expected structure and provides a straightforward method, get(), to fetch and utilize them in a TypeScript project.

## How it works

The class is tailored for use with Zod, a TypeScript-centric schema declaration and validation library. It takes a ZodObject representing the anticipated shape of Meteor.settings and furnishes a get() method to fetch and validate the settings.

Upon successful validation, the method returns the verified settings. If executed on the client side, it exclusively returns the public settings to bolster security.

## Usage

1. Installation: Ensure Zod and meteor-settings-validator are installed in your project.

```bash

meteor add hschmaiske:meteor-settings-validator

meteor npm i zod

```

2. Import the class: Import the MeteorSettingsValidator class into your TypeScript file.

```typescript

import { MeteorSettingsValidator } from "hschmaiske:meteor-settings-validator";

```

3. Create a ZodObject for Meteor.settings: Define a ZodObject that represents the expected structure of Meteor.settings. For example:

```typescript

const MeteorSettingsSchema = z.object({

  public: z.object({

    // Define your public settings structure here

  }),

  // Add other properties as needed

});

```

4. Instantiate the Validator: Create an instance of MeteorSettingsValidator with your ZodObject.

```typescript

const settingsValidator = new MeteorSettingsValidator(MeteorSettingsSchema);

```

5. Retrieve and Use Meteor.settings:

- Call the get() method to retrieve and validate Meteor.settings.

```typescript

const settingsValidator = new MeteorSettingsValidator(MeteorSettingsSchema);

const settings = settingsValidator.get();

// and you can use like this:

settings.public.myCustomKey

```

- TODO: add tests