Class URLBuilder

Constructor for URLBuilder

Example

const urlBuilder = new URLBuilder({
  baseUrl: 'https://example.com',
  path: '/path/to/resource',
  queryBuilder: new QueryBuilder({ page: 1, limit: 10, search: 'hello' }),
});
Copy

Throws

If the baseUrl is invalid

Throws

If the path is invalid

Throws

If the query parameters are invalid

Getter for the base URL

Example

const urlBuilder = new URLBuilder({
  baseUrl: 'https://example.com',
  path: '/path/to/resource',
  query: { page: 1, limit: 10, search: 'hello' },
});
console.log(urlBuilder.baseUrl); // https://example.com
Copy

Getter for the path

Example

const urlBuilder = new URLBuilder({
  baseUrl: 'https://example.com',
  path: '/path/to/resource',
});
console.log(urlBuilder.path); // /path/to/resource
Copy

Getter for the query builder

Example

const urlBuilder = new URLBuilder({
  baseUrl: 'https://example.com',
  path: '/path/to/resource',
  queryBuilder: new QueryBuilder({ page: 1, limit: 10, search: 'hello' }),
});
console.log(urlBuilder.queryBuilder); // QueryBuilder { query: { page: 1, limit: 10, search: 'hello' } }
Copy

Builds the URL with query parameters

Example

const urlBuilder = new URLBuilder({
  baseUrl: 'https://example.com',
  path: '/path/to/resource',
  query: { page: 1, limit: 10, search: 'hello' },
});
console.log(urlBuilder.build()); // https://example.com/path/to/resource?page=1&limit=10&search=hello
Copy

Replace path parameters with the given parameters

Example

const urlBuilder = new URLBuilder({
  baseUrl: 'https://example.com',
  path: '/path/:id',
});
console.log(urlBuilder.path); // /path/:id
urlBuilder.replacePathParams({ id: '123' });
console.log(urlBuilder.path); // /path/123
Copy

Throws

If the path parameter is missing