@ukwhatn/wikidot 4.0.2 → 4.0.3

package/dist/index.d.cts

@@ -1942,8 +1942,18 @@ declare class SiteAccessor {
 	constructor(client: Client);
 	/**
 	* UNIX名からサイトを取得する
+	*
 	* @param unixName - サイトのUNIX名（例: 'scp-jp'）
-	* @returns サイトオブジェクト
+	* @returns Result型でラップされたサイトオブジェクト
+	*
+	* @example
+	* ```typescript
+	* const siteResult = await client.site.get('scp-jp');
+	* if (!siteResult.isOk()) {
+	*   throw new Error('サイトの取得に失敗しました');
+	* }
+	* const site = siteResult.value;
+	* ```
 	*/
 	get(unixName: string): WikidotResultAsync<Site>;
 }
@@ -1962,9 +1972,19 @@ declare class UserAccessor {
 	constructor(client: Client);
 	/**
 	* ユーザー名からユーザーを取得する
+	*
 	* @param name - ユーザー名
 	* @param options - 取得オプション
-	* @returns ユーザー（存在しない場合はnull、raiseWhenNotFoundがtrueの場合はエラー）
+	* @returns Result型でラップされたユーザー（存在しない場合はnull、raiseWhenNotFoundがtrueの場合はエラー）
+	*
+	* @example
+	* ```typescript
+	* const userResult = await client.user.get('username');
+	* if (!userResult.isOk()) {
+	*   throw new Error('ユーザーの取得に失敗しました');
+	* }
+	* const user = userResult.value;
+	* ```
 	*/
 	get(name: string, options?: GetUserOptions): WikidotResultAsync<User | null>;
 	/**
@@ -2023,8 +2043,29 @@ declare class Client {
 	get me(): User | null;
 	/**
 	* クライアントを作成する
+	*
 	* @param options - クライアントオプション
-	* @returns クライアントインスタンス
+	* @returns Result型でラップされたクライアントインスタンス
+	*
+	* @example
+	* ```typescript
+	* import { Client } from '@ukwhatn/wikidot';
+	*
+	* // クライアントを作成
+	* const clientResult = await Client.create({
+	*   username: 'your_username',
+	*   password: 'your_password',
+	* });
+	*
+	* // Result型なのでisOk()でチェック後、.valueで取得
+	* if (!clientResult.isOk()) {
+	*   throw new Error('クライアントの作成に失敗しました');
+	* }
+	* const client = clientResult.value;
+	*
+	* // これでclient.site等にアクセス可能
+	* const siteResult = await client.site.get('scp-jp');
+	* ```
 	*/
 	static create(options?: ClientOptions): WikidotResultAsync<Client>;
 	/**
@@ -2052,14 +2093,25 @@ declare class Client {
 }
 /**
 * プライベートメッセージ操作アクセサ
+*
+* @example
+* ```typescript
+* // 受信箱を取得
+* const inboxResult = await client.privateMessage.inbox();
+* if (!inboxResult.isOk()) {
+*   throw new Error('受信箱の取得に失敗しました');
+* }
+* const inbox = inboxResult.value;
+* ```
 */
 declare class PrivateMessageAccessor {
 	readonly client: Client;
 	constructor(client: Client);
 	/**
 	* メッセージIDからメッセージを取得する
+	*
 	* @param id - メッセージID
-	* @returns メッセージオブジェクト
+	* @returns Result型でラップされたメッセージオブジェクト
 	*/
 	get(id: number): WikidotResultAsync<PrivateMessage>;
 	/**

package/dist/index.d.ts

@@ -1942,8 +1942,18 @@ declare class SiteAccessor {
 	constructor(client: Client);
 	/**
 	* UNIX名からサイトを取得する
+	*
 	* @param unixName - サイトのUNIX名（例: 'scp-jp'）
-	* @returns サイトオブジェクト
+	* @returns Result型でラップされたサイトオブジェクト
+	*
+	* @example
+	* ```typescript
+	* const siteResult = await client.site.get('scp-jp');
+	* if (!siteResult.isOk()) {
+	*   throw new Error('サイトの取得に失敗しました');
+	* }
+	* const site = siteResult.value;
+	* ```
 	*/
 	get(unixName: string): WikidotResultAsync<Site>;
 }
@@ -1962,9 +1972,19 @@ declare class UserAccessor {
 	constructor(client: Client);
 	/**
 	* ユーザー名からユーザーを取得する
+	*
 	* @param name - ユーザー名
 	* @param options - 取得オプション
-	* @returns ユーザー（存在しない場合はnull、raiseWhenNotFoundがtrueの場合はエラー）
+	* @returns Result型でラップされたユーザー（存在しない場合はnull、raiseWhenNotFoundがtrueの場合はエラー）
+	*
+	* @example
+	* ```typescript
+	* const userResult = await client.user.get('username');
+	* if (!userResult.isOk()) {
+	*   throw new Error('ユーザーの取得に失敗しました');
+	* }
+	* const user = userResult.value;
+	* ```
 	*/
 	get(name: string, options?: GetUserOptions): WikidotResultAsync<User | null>;
 	/**
@@ -2023,8 +2043,29 @@ declare class Client {
 	get me(): User | null;
 	/**
 	* クライアントを作成する
+	*
 	* @param options - クライアントオプション
-	* @returns クライアントインスタンス
+	* @returns Result型でラップされたクライアントインスタンス
+	*
+	* @example
+	* ```typescript
+	* import { Client } from '@ukwhatn/wikidot';
+	*
+	* // クライアントを作成
+	* const clientResult = await Client.create({
+	*   username: 'your_username',
+	*   password: 'your_password',
+	* });
+	*
+	* // Result型なのでisOk()でチェック後、.valueで取得
+	* if (!clientResult.isOk()) {
+	*   throw new Error('クライアントの作成に失敗しました');
+	* }
+	* const client = clientResult.value;
+	*
+	* // これでclient.site等にアクセス可能
+	* const siteResult = await client.site.get('scp-jp');
+	* ```
 	*/
 	static create(options?: ClientOptions): WikidotResultAsync<Client>;
 	/**
@@ -2052,14 +2093,25 @@ declare class Client {
 }
 /**
 * プライベートメッセージ操作アクセサ
+*
+* @example
+* ```typescript
+* // 受信箱を取得
+* const inboxResult = await client.privateMessage.inbox();
+* if (!inboxResult.isOk()) {
+*   throw new Error('受信箱の取得に失敗しました');
+* }
+* const inbox = inboxResult.value;
+* ```
 */
 declare class PrivateMessageAccessor {
 	readonly client: Client;
 	constructor(client: Client);
 	/**
 	* メッセージIDからメッセージを取得する
+	*
 	* @param id - メッセージID
-	* @returns メッセージオブジェクト
+	* @returns Result型でラップされたメッセージオブジェクト
 	*/
 	get(id: number): WikidotResultAsync<PrivateMessage>;
 	/**