Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Code formatting and a new ESLint rule #72

Merged
merged 2 commits into from
Oct 5, 2020
Merged

Code formatting and a new ESLint rule #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41cf4fd
Break up long function signatures
balazsbotond Oct 5, 2020
4b6be50
ESLint: forbid console.log
balazsbotond Oct 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions .eslintrc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@ module.exports = {
'object-curly-spacing': ['error', 'always'],
'array-bracket-spacing': ['error', 'never'],
'quotes': ['error', 'single'],
'no-console': ['error'],
}
};
38 changes: 31 additions & 7 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ import qs, { IStringifyOptions } from 'qs';

// eslint-disable-next-line @typescript-eslint/no-explicit-any
export type ParamMap = Record<string, any>;
export type UrlCatConfiguration = Partial<Pick<IStringifyOptions, 'arrayFormat'> & {objectFormat: Partial<Pick<IStringifyOptions, 'format'>>}>
export type UrlCatConfiguration =
Partial<Pick<IStringifyOptions, 'arrayFormat'> & { objectFormat: Partial<Pick<IStringifyOptions, 'format'>> }>

/**
* Builds a URL using the base template and specified parameters.
Expand Down Expand Up @@ -57,7 +58,11 @@ export default function urlcat(baseUrl: string, path: string): string;
* // -> 'http://api.example.com/users/42?search=foo
* ```
*/
export default function urlcat(baseUrl: string, pathTemplate: string, params: ParamMap): string;
export default function urlcat(
baseUrl: string,
pathTemplate: string,
params: ParamMap
): string;

/**
* Concatenates the base URL and the path specified using '/' as a separator.
Expand All @@ -79,9 +84,19 @@ export default function urlcat(baseUrl: string, pathTemplate: string, params: Pa
* // -> 'http://api.example.com/users/42?search=foo
* ```
*/
export default function urlcat(baseUrlOrTemplate: string, pathTemplateOrParams: string | ParamMap, maybeParams: ParamMap, config: UrlCatConfiguration): string;

export default function urlcat(baseUrlOrTemplate: string, pathTemplateOrParams: string | ParamMap, maybeParams: ParamMap = {}, config: UrlCatConfiguration = {}): string {
export default function urlcat(
baseUrlOrTemplate: string,
pathTemplateOrParams: string | ParamMap,
maybeParams: ParamMap,
config: UrlCatConfiguration
): string;

export default function urlcat(
baseUrlOrTemplate: string,
pathTemplateOrParams: string | ParamMap,
maybeParams: ParamMap = {},
config: UrlCatConfiguration = {}
): string {
if (typeof pathTemplateOrParams === 'string') {
const baseUrl = baseUrlOrTemplate;
const pathTemplate = pathTemplateOrParams;
Expand All @@ -107,11 +122,20 @@ export default function urlcat(baseUrlOrTemplate: string, pathTemplateOrParams:
* ```
*/
export function configure(rootConfig: UrlCatConfiguration) {
return (baseUrlOrTemplate: string, pathTemplateOrParams: string | ParamMap, maybeParams: ParamMap = {}, config: UrlCatConfiguration = {}): string =>
return (
baseUrlOrTemplate: string,
pathTemplateOrParams: string | ParamMap,
maybeParams: ParamMap = {}, config: UrlCatConfiguration = {}
): string =>
urlcat(baseUrlOrTemplate, pathTemplateOrParams, maybeParams , { ...rootConfig, ...config });
}

function urlcatImpl(pathTemplate: string, params: ParamMap, baseUrl: string | undefined, config: UrlCatConfiguration) {
function urlcatImpl(
pathTemplate: string,
params: ParamMap,
baseUrl: string | undefined,
config: UrlCatConfiguration
) {
const { renderedPath, remainingParams } = path(pathTemplate, params);
const cleanParams = removeNullOrUndef(remainingParams);
const renderedQuery = query(cleanParams, config);
Expand Down