Skip to content

Commit

Permalink
For v3.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
danielwertheim committed Jun 3, 2017
1 parent 1f93b2e commit 894d4f7
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 3 deletions.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,13 @@ install-package structurizer
```

### Builder construction
**KEEP HOLD OF THE STRUCTUREBUILDER!** The `StructureBuilder.Create` function, will create the `Schemas` underneath. The Scheams contains a cache of IL-generated members for effective extraction of values.
The easiest builder to use is the `FlexibleStructureBuilder` (introduced in `v3.0.0`).

```csharp
var builder = new FlexibleStructureBuilder();
```

You can also use the more static configured `StructureBuilder`:

```csharp
var typeConfigs = new StructureTypeConfigurations();
Expand Down Expand Up @@ -76,6 +82,17 @@ ManyChildren[1].SomeString=List Child2
```

## Control what's being indexed

### Using the FlexibleStructureBuilder
At any point (last in wins), just use the `Configure` methods, e.g.

```csharp
builder.Configure(i => cfg
.UseIndexMode(IndexMode.Inclusive)
.Members(e => e.Name, e => e.Score));
```

### Using the Static StructureBuilder
This is controlled using the `StructureTypeConfigurations.Register` member.

By default it's going to index everything as the default is to have `IndexMode.Exclusive` with no exclusions. This can be changed.
Expand Down
5 changes: 4 additions & 1 deletion ReleaseNotes.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
#Release notes

## v3.1.0 - 2017-06-03
- *New*: Added `IStructureIndex.IsNumeric` to indicate if the carried value is numeric or not. Use `DataTypeCode` for more finegrained details.

## v3.0.0 - 2017-06-03
- *New*: `FlexibleStructureBuilder` which doesn't require you to pre-register types. It will do that automatically upon first contact with a new type. You can configure and reconfigure it at any time.
- *New*: `StructureTypeConfigurations` are now thread-safe and you can call register multiple times, last in wins.
- *Changed*: `StructureTypeConfigurations` are now thread-safe and you can call register multiple times, last in wins.

## v2.0.0 - 2017-05-02
- Updated to target .NET Standard 1.3
Expand Down
2 changes: 1 addition & 1 deletion buildconfig.cake
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
public class BuildConfig
{
private const string Version = "3.0.0";
private const string Version = "3.1.0";
private const bool IsPreRelease = false;

public readonly string SrcDir = "./src/";
Expand Down

0 comments on commit 894d4f7

Please sign in to comment.