search

szmarczak / cacheable-lookup

A cacheable dns.lookup(…) that respects TTL :tada:
MIT License
193 stars 29 forks source link

Add entry source, either cache or query #63

Closed monkbroc closed 2 years ago

monkbroc commented 2 years ago

When adding instrumentation around DNS lookups, it would be very helpful to be able to distinguish if an entry came from the cache or a fresh query. This would allow to compute the cache hit rate and to calculate stats on the duration of DNS queries, ignoring when the cache is hit.

The source is either cache or query. It is returned with the entry from lookupAsync and it is added as an extra parameter to the callback from lookup.

I didn't add the source parameter to the callback type definitions in https://github.com/szmarczak/cacheable-lookup/blob/master/index.d.ts#L102-L105 since the expires and ttl were already omitted. I wasn't sure if that was on purpose or if it was an omission.

szmarczak commented 2 years ago

Thanks a lot! ❤️

szmarczak commented 2 years ago

Released cacheable-lookup@6.1.0 :tada:

szmarczak commented 2 years ago

I wasn't sure if that was on purpose or if it was an omission.

It was on purpose to make the typings compatible.

monkbroc commented 2 years ago

Thanks for merging and releasing!