File tree 2 files changed +18
-0
lines changed
2 files changed +18
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Introduction to the plugin system
2
+
3
+ For more customization, ` TypedStructor ` provides a plugin system
4
+ that allows you to extend the functionality of the library.
5
+ This is useful when you want to extract some common logic into a separate module.
6
+
7
+ See ` TypedStructor.Plugin ` for how to create a plugin.
8
+
9
+ This library comes with a few built-in plugins, and we don't like to
10
+ implement more built-in plugins, but instead, we encourage you to create your own plugins.
11
+ We provide some example plugins that you can use as a reference, or copy-paste.
12
+
13
+ ** Plugin examples:**
14
+ - [ Registering plugins globally] ( ./registering_plugins_globally.md )
15
+ - ` TypedStructor.Plugins.Accessible `
16
+ - [ Type Only on Ecto Schema] ( ./type_only_on_ecto_schema.md )
17
+ - [ Add primary key and timestamps types to your Ecto schema] ( ./primary_key_and_timestamps.md )
Original file line number Diff line number Diff line change @@ -31,6 +31,7 @@ defmodule TypedStructor.MixProject do
31
31
"guides/migrate_from_typed_struct.md" ,
32
32
33
33
# plugins
34
+ { "guides/plugins/introduction.md" , [ title: "Introduction" ] } ,
34
35
"guides/plugins/registering_plugins_globally.md" ,
35
36
"guides/plugins/type_only_on_ecto_schema.md" ,
36
37
"guides/plugins/primary_key_and_timestamps.md"
You can’t perform that action at this time.
0 commit comments