From d95337c085566570a4b9e206df91267cfcea3e6b Mon Sep 17 00:00:00 2001 From: leejooy96 Date: Thu, 5 Dec 2024 13:53:24 +0900 Subject: [PATCH] docs: update docs for `qsu-web` --- docs/src/en/api/web.md | 21 +++++++++++++++++++ .../installation-javascript.md | 4 ++-- docs/src/ko/api/web.md | 21 +++++++++++++++++++ .../installation-javascript.md | 4 ++-- 4 files changed, 46 insertions(+), 4 deletions(-) diff --git a/docs/src/en/api/web.md b/docs/src/en/api/web.md index b4c869b..9a8ba37 100644 --- a/docs/src/en/api/web.md +++ b/docs/src/en/api/web.md @@ -7,6 +7,27 @@ order: 100 This method is only available in the `qsu-web` (JavaScript) package. +## `isMatchPathname` + +You can check if the URL path in the first argument value is matched against the second set of rules. The matching rules can take a string or an array of strings, where both arguments are paths that start with `/`. You can use wildcards (`*`) in the rules. For example, `user/*` would match all pages that start with `/user`. + +### Parameters + +- `pathname::string` +- `matcher::string|string[]` + +### Returns + +> boolean + +### Examples + +```javascript +_.isMatchPathname('/user/login', '/admin'); // Returns false +_.isMatchPathname('/user/login', '/user*'); // Returns true +_.isMatchPathname('/user/login', ['/test', '/home/hello', '/user/*']); // Returns true +``` + ## `isBotAgent` Analyze the user agent value to determine if it's a bot for a search engine. Returns `true` if it's a bot. diff --git a/docs/src/en/getting-started/installation-javascript.md b/docs/src/en/getting-started/installation-javascript.md index d8b7109..fc6b5f4 100644 --- a/docs/src/en/getting-started/installation-javascript.md +++ b/docs/src/en/getting-started/installation-javascript.md @@ -27,7 +27,7 @@ $ pnpm install qsu-web # (Optional) When using the Add-on for Web ## How to Use -일반적으로 각각의 함수를 아래와 같이 부분적으로 import하여 사용할 수 있습니다. +In general, you can partially import and use each function as shown below. ```javascript import { today, strCount } from 'qsu'; @@ -38,7 +38,7 @@ function main() { } ``` -코드와 모듈의 구분을 위해 아래처럼 언더스코어(`_`)기호 등을 사용하여 메소드를 사용할 수 있습니다. 특별한 경우가 아니면 부분 가져오기를 사용하는 것을 권장합니다. +You can use methods with underscore (`_`) symbols to separate code and modules, as shown below. We recommend using partial imports unless there are special cases. ```javascript import * as _ from 'qsu'; diff --git a/docs/src/ko/api/web.md b/docs/src/ko/api/web.md index b4c869b..b60a410 100644 --- a/docs/src/ko/api/web.md +++ b/docs/src/ko/api/web.md @@ -7,6 +7,27 @@ order: 100 This method is only available in the `qsu-web` (JavaScript) package. +## `isMatchPathname` + +처음 인자값의 URL 경로가 두번째 rule set에 매칭되는지 확인할 수 있습니다. 매칭 규칙은 string 또는 string으로 구성된 배열을 사용할 수 있으며, 두 인자 모두 경로는 `/`으로 시작합니다. 규칙에는 와일드카드(`*`)를 사용할 수 있습니다. 예를 들어 `user/*`인 경우 `/user`로 시작되는 페이지가 모두 해당됩니다. + +### Parameters + +- `pathname::string` +- `matcher::string|string[]` + +### Returns + +> boolean + +### Examples + +```javascript +_.isMatchPathname('/user/login', '/admin'); // Returns false +_.isMatchPathname('/user/login', '/user*'); // Returns true +_.isMatchPathname('/user/login', ['/test', '/home/hello', '/user/*']); // Returns true +``` + ## `isBotAgent` Analyze the user agent value to determine if it's a bot for a search engine. Returns `true` if it's a bot. diff --git a/docs/src/ko/getting-started/installation-javascript.md b/docs/src/ko/getting-started/installation-javascript.md index 50bd2b5..d5a4154 100644 --- a/docs/src/ko/getting-started/installation-javascript.md +++ b/docs/src/ko/getting-started/installation-javascript.md @@ -27,7 +27,7 @@ $ pnpm install qsu-web # (선택적) Web용 추가 유틸을 사용할 때 ## 사용 방법 -In general, you can partially import and use each function as shown below. +일반적으로 각각의 함수를 아래와 같이 부분적으로 import하여 사용할 수 있습니다. ```javascript import { today, strCount } from 'qsu'; @@ -38,7 +38,7 @@ function main() { } ``` -You can use methods with underscore (`_`) symbols to separate code and modules, as shown below. We recommend using partial imports unless there are special cases. +코드와 모듈의 구분을 위해 아래처럼 언더스코어(`_`)기호 등을 사용하여 메소드를 사용할 수 있습니다. 특별한 경우가 아니면 부분 가져오기를 사용하는 것을 권장합니다. ```javascript import _ from 'qsu';