Welcome to the World of cached-path-relative

The cached-path-relative package empowers developers with efficient path caching, making code management streamlined and less error-prone. Whether you’re dealing with relative paths in a Node.js environment or enhancing code performance, this package offers comprehensive API solutions.

Getting Started

Before diving into the detailed API explanations, ensure you have cached-path-relative installed in your project. Use the following command:

  npm install cached-path-relative

API Overview

The cached-path-relative package offers several useful APIs:

1. getCachedPath(base, relative)

This function returns the absolute path by combining the base path and relative path, utilizing caching for efficient retrieval.

  const { getCachedPath } = require('cached-path-relative');
  const basePath = '/Users/project';
  const relativePath = 'src/index.js';
  const fullPath = getCachedPath(basePath, relativePath);
  console.log(fullPath); // Outputs: '/Users/project/src/index.js'

2. clearCache()

Clears the entire cache to free up memory or reset the stored paths.

  const { clearCache } = require('cached-path-relative');
  clearCache();

3. isPathCached(path)

Checks if a certain path is already cached for quick access.

  const { isPathCached } = require('cached-path-relative');
  const path = '/Users/project/src/index.js';
  const cached = isPathCached(path);
  console.log(cached); // Outputs: true or false

App Example

Let’s see a complete example of an application using these APIs:

  const { getCachedPath, clearCache, isPathCached } = require('cached-path-relative');
  
  function exampleApp() {
    const basePath = '/Users/project';
    const relativePaths = ['src/index.js', 'src/app.js', 'src/utils.js'];
    
    relativePaths.forEach(relPath => {
      const fullPath = getCachedPath(basePath, relPath);
      console.log(`Full path for ${relPath}: ${fullPath}`);
    });
    
    console.log('Clearing cache...');
    clearCache();
    
    relativePaths.forEach(relPath => {
      const fullPath = getCachedPath(basePath, relPath);
      console.log(`Full path for ${relPath} after clearing cache: ${fullPath}`);
    });
  }
  
  exampleApp();

In this example, we efficiently manage and retrieve paths using the cached-path-relative APIs, ensuring optimized performance and simplified code.

Explore more with cached-path-relative and make your Node.js projects robust and maintainable!

Hash: acd7b86987c1751209a804f8337643417ad9d6eaf22ac155652ea2a5ed171ae2