npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

caddy-json-types

v1.0.3-alpha.0

Published

TypeScript typings for Caddy JSON configuration. This package provides comprehensive TypeScript definitions for Caddy's JSON configuration format, enabling type safety and enhanced developer experience when working with Caddy's configuration files in Type

Downloads

16

Readme

caddy-json-types

TypeScript typings for Caddy JSON configuration. This package provides comprehensive TypeScript definitions for Caddy's JSON configuration format, enabling type safety and enhanced developer experience when working with Caddy's configuration files in TypeScript projects.

Features

  • Type Safety: Ensure your Caddy JSON configurations are type-checked for errors.
  • Enhanced Developer Experience: Get autocompletion and inline documentation in your editor.
  • Comprehensive Documentation: Includes full original documentation as comments for each type and field.

Installation

You can install the package via npm:

npm install caddy-json-types

Or with yarn:

yarn add caddy-json-types

Usage

To use the typings in your TypeScript project, import the package in your TypeScript files:

import type { IConfig } from 'caddy-json-types';

// Example usage
const config: IConfig = {
    // your Caddy JSON configuration here
};

Example

Here's an example of how you can use the typings with a Caddy JSON configuration:

import type { IConfig } from 'caddy-json-types';

const config: IConfig = {
    apps: {
        http: {
            servers: {
                myserver: {
                    listen: [\":443\"],
                    routes: [
                        {
                            match: [
                                {
                                    host: [\"example.com\"]
                                }
                            ],
                            handle: [
                                {
                                    handler: \"static_response\",
                                    body: \"Hello, world!\"
                                }
                            ]
                        }
                    ]
                }
            }
        }
    }
};

// Use the config object as needed
console.log(config);

Contributing

Contributions are welcome! Please open an issue or submit a pull request if you have any improvements or fixes.

  1. Fork the repository
  2. Create a new branch (git checkout -b my-feature-branch)
  3. Make your changes
  4. Commit your changes (git commit -am 'Add new feature')
  5. Push to the branch (git push origin my-feature-branch)
  6. Create a new Pull Request

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

This project is not affiliated with or endorsed by the Caddy project. It is an independent project created to improve the developer experience when working with Caddy JSON configurations in TypeScript.


For more information on Caddy and its configuration options, please visit the official Caddy documentation.