Skip to content

Commit

Permalink
build(deps-dev): replace standard with neostandard
Browse files Browse the repository at this point in the history
  • Loading branch information
Fdawgs committed Dec 8, 2024
1 parent dce43da commit 2bd0e14
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 31 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[![CI](https://github.com/fastify/fastify-circuit-breaker/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/fastify/fastify-circuit-breaker/actions/workflows/ci.yml)
[![NPM version](https://img.shields.io/npm/v/@fastify/circuit-breaker.svg?style=flat)](https://www.npmjs.com/package/@fastify/circuit-breaker)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)

A low overhead [circuit breaker](https://martinfowler.com/bliki/CircuitBreaker.html) for your routes.

Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
"types": "types/index.d.ts",
"type": "commonjs",
"scripts": {
"lint": "standard",
"lint": "eslint",
"lint:fix": "eslint --fix",
"test": "npm run test:unit && npm run test:typescript",
"test:unit": "c8 -100 node --test",
"test:typescript": "tsd"
Expand All @@ -30,7 +31,7 @@
"@types/node": "^22.0.0",
"c8": "^10.1.2",
"fastify": "^5.0.0",
"standard": "^17.1.0",
"neostandard": "^0.11.9",
"tsd": "^0.31.1"
},
"dependencies": {
Expand Down
12 changes: 6 additions & 6 deletions types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@ import {
FastifyRequest,
FastifyReply,
HookHandlerDoneFunction,
} from "fastify";
import { Stream } from "node:stream";
} from 'fastify'
import { Stream } from 'node:stream'

declare module "fastify" {
declare module 'fastify' {
interface FastifyInstance {
circuitBreaker(
options?: fastifyCircuitBreaker.FastifyCircuitBreakerOptions
): fastifyCircuitBreaker.FastifyCircuitBreakerBeforeHandler;
}
}

type FastifyCircuitBreaker = FastifyPluginCallback<fastifyCircuitBreaker.FastifyCircuitBreakerOptions>;
type FastifyCircuitBreaker = FastifyPluginCallback<fastifyCircuitBreaker.FastifyCircuitBreakerOptions>

declare namespace fastifyCircuitBreaker {
export interface FastifyCircuitBreakerBeforeHandler {
Expand Down Expand Up @@ -75,10 +75,10 @@ declare namespace fastifyCircuitBreaker {
* @default 500
*/
cache?: number;
};
}
export const fastifyCircuitBreaker: FastifyCircuitBreaker
export { fastifyCircuitBreaker as default }
}

declare function fastifyCircuitBreaker(...params: Parameters<FastifyCircuitBreaker>): ReturnType<FastifyCircuitBreaker>
declare function fastifyCircuitBreaker (...params: Parameters<FastifyCircuitBreaker>): ReturnType<FastifyCircuitBreaker>
export = fastifyCircuitBreaker
44 changes: 22 additions & 22 deletions types/index.test-d.ts
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
import fastify, { FastifyReply, FastifyRequest } from "fastify";
import { expectType } from "tsd";
import FastifyCircuitBreaker, { FastifyCircuitBreakerOptions } from "..";
import fastify, { FastifyReply, FastifyRequest } from 'fastify'
import { expectType } from 'tsd'
import FastifyCircuitBreaker, { FastifyCircuitBreakerOptions } from '..'

const app = fastify();
const app = fastify()

app.register(FastifyCircuitBreaker);
app.register(FastifyCircuitBreaker, {});
app.register(FastifyCircuitBreaker, { timeout: 5000 });
app.register(FastifyCircuitBreaker, { threshold: 5 });
app.register(FastifyCircuitBreaker, { resetTimeout: 10000 });
app.register(FastifyCircuitBreaker)
app.register(FastifyCircuitBreaker, {})
app.register(FastifyCircuitBreaker, { timeout: 5000 })
app.register(FastifyCircuitBreaker, { threshold: 5 })
app.register(FastifyCircuitBreaker, { resetTimeout: 10000 })
app.register(FastifyCircuitBreaker, {
timeout: 5000,
threshold: 5,
resetTimeout: 10000,
});
})

const fastifyCircuitBreakerOptions: FastifyCircuitBreakerOptions = {
timeout: 5000,
threshold: 5,
resetTimeout: 10000,
};
app.register(FastifyCircuitBreaker, fastifyCircuitBreakerOptions);
}
app.register(FastifyCircuitBreaker, fastifyCircuitBreakerOptions)

app.get(
"/",
'/',
{
preHandler: app.circuitBreaker(),
},
(req, reply) => { }
);
)

app.register(FastifyCircuitBreaker, { timeoutErrorMessage: 'Timeon' });
app.register(FastifyCircuitBreaker, { timeoutErrorMessage: 'Timeon' })
app.register(FastifyCircuitBreaker, {
onTimeout: async (req, reply) => {
expectType<FastifyRequest>(req)
Expand All @@ -39,25 +39,25 @@ app.register(FastifyCircuitBreaker, {
reply.statusCode = statusCode
throw new Error('timed out')
}
});
})
app.register(FastifyCircuitBreaker, {
onTimeout: (req, reply) => {
expectType<FastifyRequest>(req)
expectType<FastifyReply>(reply)
reply.statusCode = 504
return 'timed out'
}
});
})
app.register(FastifyCircuitBreaker, {
onTimeout: async (req, reply) => {
expectType<FastifyRequest>(req)
expectType<FastifyReply>(reply)
reply.statusCode = 504
return 'timed out'
}
});
})

app.register(FastifyCircuitBreaker, { circuitOpenErrorMessage: 'circus open' });
app.register(FastifyCircuitBreaker, { circuitOpenErrorMessage: 'circus open' })
app.register(FastifyCircuitBreaker, {
onCircuitOpen: async (req, reply) => {
expectType<FastifyRequest>(req)
Expand All @@ -66,20 +66,20 @@ app.register(FastifyCircuitBreaker, {
reply.statusCode = statusCode
throw new Error('circuit open')
}
});
})
app.register(FastifyCircuitBreaker, {
onCircuitOpen: (req, reply) => {
expectType<FastifyRequest>(req)
expectType<FastifyReply>(reply)
reply.statusCode = 504
return 'circuit open'
}
});
})
app.register(FastifyCircuitBreaker, {
onCircuitOpen: async (req, reply) => {
expectType<FastifyRequest>(req)
expectType<FastifyReply>(reply)
reply.statusCode = 504
return 'circuit open'
}
});
})

0 comments on commit 2bd0e14

Please # to comment.