From 82dd070321462120feb390a7602062714f930753 Mon Sep 17 00:00:00 2001 From: erikatharp Date: Mon, 10 Apr 2023 10:22:51 -0700 Subject: [PATCH 1/2] chore: update JP ver. of README --- README.ja.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.ja.md b/README.ja.md index 56ca3cec..1f3544fd 100644 --- a/README.ja.md +++ b/README.ja.md @@ -4,7 +4,7 @@ logo [![project status](https://momentohq.github.io/standards-and-practices/badges/project-status-official.svg)](https://github.com/momentohq/standards-and-practices/blob/main/docs/momento-on-github.md) -[![project stability](https://momentohq.github.io/standards-and-practices/badges/project-stability-beta.svg)](https://github.com/momentohq/standards-and-practices/blob/main/docs/momento-on-github.md) +[![project stability](https://momentohq.github.io/standards-and-practices/badges/project-stability-stable.svg)](https://github.com/momentohq/standards-and-practices/blob/main/docs/momento-on-github.md) # Momento .NET Client Library From af01037144033da40082c30b922c5fd1c5237736 Mon Sep 17 00:00:00 2001 From: erikatharp Date: Mon, 10 Apr 2023 15:43:04 -0700 Subject: [PATCH 2/2] chore: rename to CacheClient --- README.ja.md | 12 ++++++------ README.template.md | 10 +++++----- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.ja.md b/README.ja.md index 1f3544fd..1e2f42c5 100644 --- a/README.ja.md +++ b/README.ja.md @@ -24,7 +24,7 @@ Momento Serverless Cache の .NET クライアント SDK：従来のキャッシ ### Momento レスポンスタイプ -Momento の`SimpleCacheClient`クラスの戻り値は IDE が容易にエラーを含む、有り得るレスポンスを予測できる様にデザインしてあります。[パターンマッチング](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/functional/pattern-matching)を使用し、様々なレスポンスタイプを区別します。そうすることで、それらの API を使用する時、ランタイムでバグを発見するよりも、コンパイル時での安全性があります。 +Momento の`CacheClient`クラスの戻り値は IDE が容易にエラーを含む、有り得るレスポンスを予測できる様にデザインしてあります。[パターンマッチング](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/functional/pattern-matching)を使用し、様々なレスポンスタイプを区別します。そうすることで、それらの API を使用する時、ランタイムでバグを発見するよりも、コンパイル時での安全性があります。 以下が使用例です: @@ -70,7 +70,7 @@ const string KEY = "MyKey"; const string VALUE = "MyData"; TimeSpan DEFAULT_TTL = TimeSpan.FromSeconds(60); -using (SimpleCacheClient client = new SimpleCacheClient(Configurations.Laptop.Latest(), authProvider, DEFAULT_TTL)) +using (CacheClient client = new CacheClient(Configurations.Laptop.Latest(), authProvider, DEFAULT_TTL)) { var createCacheResponse = await client.CreateCacheAsync(CACHE_NAME); if (createCacheResponse is CreateCacheResponse.Error createError) @@ -105,9 +105,9 @@ using (SimpleCacheClient client = new SimpleCacheClient(Configurations.Laptop.La ### エラーの処理法 -従来の例外処理とは異なり、SimpleCacheClient のメソッドを呼び出した際に起こるエラーは戻り値として浮上します。こうすることで、エラーの可視化を行い、必要なエラーのみを処理する際に IDE が更に役立つ様になります。（もっと例外についての私達の哲学を知りたい方はこちらの[例外はバグだ](https://www.gomomento.com/blog/exceptions-are-bugs)をぜひお読みください。またフィードバックもお待ちしております！） +従来の例外処理とは異なり、CacheClient のメソッドを呼び出した際に起こるエラーは戻り値として浮上します。こうすることで、エラーの可視化を行い、必要なエラーのみを処理する際に IDE が更に役立つ様になります。（もっと例外についての私達の哲学を知りたい方はこちらの[例外はバグだ](https://www.gomomento.com/blog/exceptions-are-bugs)をぜひお読みください。またフィードバックもお待ちしております！） -SimpleCacheClient メソッドからの戻り値の好ましい対応の仕方は[パターンマッチング](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/functional/pattern-matching)を使用する方法です。こちらが簡単な例です： +CacheClient メソッドからの戻り値の好ましい対応の仕方は[パターンマッチング](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/functional/pattern-matching)を使用する方法です。こちらが簡単な例です： ```csharp CacheGetResponse getResponse = await client.GetAsync(CACHE_NAME, KEY); @@ -136,8 +136,8 @@ if (getResponse is CacheGetResponse.Error errorResponse) } ``` -SimpleCacheClient の戻り値以外では例外が起こる可能性があり、それらは通常通り処理する必要があるのでご注意ください。 -例えば、SimpleCacheClient のインスタンスを生成する際、無効なオーセンティケーショントークンは IllegalArgumentException の発生原因になります。 +CacheClient の戻り値以外では例外が起こる可能性があり、それらは通常通り処理する必要があるのでご注意ください。 +例えば、CacheClient のインスタンスを生成する際、無効なオーセンティケーショントークンは IllegalArgumentException の発生原因になります。 ### チューニング diff --git a/README.template.md b/README.template.md index f0e71751..1c96ee45 100644 --- a/README.template.md +++ b/README.template.md @@ -17,7 +17,7 @@ how to use the SDK. ### Momento Response Types -The return values of the methods on the Momento `SimpleCacheClient` class are designed to allow you to use your +The return values of the methods on the Momento `CacheClient` class are designed to allow you to use your IDE to help you easily discover all the possible responses, including errors. We use [pattern matching](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/functional/pattern-matching) to distinguish between different types of responses, which means that you can get compile-time safety when interacting with the API, rather than having bugs sneak in at runtime. @@ -61,13 +61,13 @@ be set to a valid [Momento authentication token](https://docs.momentohq.com/docs ### Error Handling -Error that occur in calls to SimpleCacheClient methods are surfaced to developers as part of the return values of +Error that occur in calls to CacheClient methods are surfaced to developers as part of the return values of the calls, as opposed to by throwing exceptions. This makes them more visible, and allows your IDE to be more helpful in ensuring that you've handled the ones you care about. (For more on our philosophy about this, see our blog post on why [Exceptions are bugs](https://www.gomomento.com/blog/exceptions-are-bugs). And send us any feedback you have!) -The preferred way of interpreting the return values from SimpleCacheClient methods is using [Pattern matching](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/functional/pattern-matching). Here's a quick example: +The preferred way of interpreting the return values from CacheClient methods is using [Pattern matching](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/functional/pattern-matching). Here's a quick example: ```csharp CacheGetResponse getResponse = await client.GetAsync(CACHE_NAME, KEY); @@ -98,8 +98,8 @@ if (getResponse is CacheGetResponse.Error errorResponse) } ``` -Note that, outside of SimpleCacheClient responses, exceptions can occur and should be handled as usual. For example, trying -to instantiate a SimpleCacheClient with an invalid authentication token will result in an IllegalArgumentException being thrown. +Note that, outside of CacheClient responses, exceptions can occur and should be handled as usual. For example, trying +to instantiate a CacheClient with an invalid authentication token will result in an IllegalArgumentException being thrown. ### Tuning