Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEAT docs] minimal adapter interface #6643

Open
wants to merge 4 commits into
base: master
from

Conversation

@runspired
Copy link
Contributor

runspired commented Oct 25, 2019

No description provided.

@runspired runspired mentioned this pull request Nov 4, 2019
72 of 72 tasks complete
@runspired runspired added this to In Development in 🌲 Project Trim 🌲 via automation Nov 4, 2019
@runspired runspired force-pushed the feat/minimal-adapter-interface branch from 4494bbe to 25f4ac3 Nov 6, 2019
@runspired runspired force-pushed the feat/minimal-adapter-interface branch from 25f4ac3 to 6b68ea5 Nov 15, 2019
@efx

This comment has been minimized.

Copy link
Contributor

efx commented Nov 15, 2019

I'll try to read through this today locally.

@runspired

This comment has been minimized.

Copy link
Contributor Author

runspired commented Nov 15, 2019

@efx still lots more work to be done

@efx

This comment has been minimized.

Copy link
Contributor

efx commented Nov 15, 2019

@runspired I see. I was thinking I could preview the overview description by generating the API documentation locally as for the MinimumSerializerInterface:
Screen Shot 2019-11-15 at 15 39 42

I see that the introduction in the .ts does not appear in the API documentation app as well. I'll hold off reviewing then.

@runspired runspired force-pushed the feat/minimal-adapter-interface branch from 6b68ea5 to 09424a2 Nov 25, 2019
@runspired runspired force-pushed the feat/minimal-adapter-interface branch from 09424a2 to a9dbffe Nov 26, 2019
@runspired runspired changed the title [WIP FEAT docs] minimal adapter interface [FEAT docs] minimal adapter interface Nov 26, 2019
@emberjs emberjs deleted a comment from github-actions bot Nov 26, 2019
@emberjs emberjs deleted a comment from github-actions bot Nov 26, 2019
@emberjs emberjs deleted a comment from github-actions bot Nov 26, 2019
@github-actions

This comment has been minimized.

Copy link

github-actions bot commented Nov 26, 2019

Asset Size Report for a9dbffe

EmberData has not changed in size

If any packages had changed sizes they would be listed here.

Changeset



Full Asset Analysis

Asset Size Report
=================


Library: EmberData
┌────────────┬─────────────┐
│  (index)   │   Values    │
├────────────┼─────────────┤
│   bytes    │ '160.49 KB' │
│ compressed │ '34.16 KB'  │
│  packages  │     10      │
│  modules   │     48      │
└────────────┴─────────────┘

Package: @ember-data/store
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '71.04 KB' │
│  compressed  │ '15.12 KB' │
│ % Of Library │   '44.3'   │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/store/-private                    | 70.13 KB  | 14.93 KB   | 98.7          | 43.7
	@ember-data/store/index                       | 936.00 B  | 199.23 B   | 1.3           | 0.6

Package: @ember-data/record-data
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '22.97 KB' │
│  compressed  │ '4.89 KB'  │
│ % Of Library │   '14.3'   │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/record-data/-private              | 22.97 KB  | 4.89 KB    | 100.0         | 14.3

Package: @ember-data/serializer
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '19.30 KB' │
│  compressed  │ '4.11 KB'  │
│ % Of Library │   '12.0'   │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/serializer/json                   | 7.10 KB   | 1.51 KB    | 36.8          | 4.4
	@ember-data/serializer/-private               | 5.36 KB   | 1.14 KB    | 27.8          | 3.3
	@ember-data/serializer/json-api               | 3.71 KB   | 807.99 B   | 19.2          | 2.3
	@ember-data/serializer/rest                   | 2.68 KB   | 583.85 B   | 13.9          | 1.7
	@ember-data/serializer/index                  | 243.00 B  | 51.72 B    | 1.2           | 0.1
	@ember-data/serializer/transform              | 215.00 B  | 45.76 B    | 1.1           | 0.1

Package: @ember-data/adapter
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '14.57 KB' │
│  compressed  │ '3.10 KB'  │
│ % Of Library │   '9.1'    │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/adapter/rest                      | 7.65 KB   | 1.63 KB    | 52.5          | 4.8
	@ember-data/adapter/-private                  | 3.50 KB   | 762.86 B   | 24.0          | 2.2
	@ember-data/adapter/error                     | 1.91 KB   | 416.98 B   | 13.1          | 1.2
	@ember-data/adapter/json-api                  | 830.00 B  | 176.66 B   | 5.6           | 0.5
	@ember-data/adapter/index                     | 719.00 B  | 153.04 B   | 4.8           | 0.4

Package: @ember-data/model
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '11.08 KB' │
│  compressed  │ '2.36 KB'  │
│ % Of Library │   '6.9'    │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/model/-private                    | 10.60 KB  | 2.26 KB    | 95.7          | 6.6
	@ember-data/model/index                       | 486.00 B  | 103.44 B   | 4.3           | 0.3

Package: ember-data
┌──────────────┬───────────┐
│   (index)    │  Values   │
├──────────────┼───────────┤
│    bytes     │ '9.72 KB' │
│  compressed  │ '2.07 KB' │
│ % Of Library │   '6.1'   │
└──────────────┴───────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	ember-data/index                              | 2.42 KB   | 527.66 B   | 24.9          | 1.5
	ember-data/-private                           | 1.98 KB   | 431.87 B   | 20.4          | 1.2
	ember-data/adapters/errors                    | 1.19 KB   | 259.04 B   | 12.2          | 0.7
	ember-data/setup-container                    | 503.00 B  | 107.06 B   | 5.1           | 0.3
	ember-data/store                              | 406.00 B  | 86.41 B    | 4.1           | 0.2
	ember-data/relationships                      | 318.00 B  | 67.68 B    | 3.2           | 0.2
	ember-data/serializers/embedded-records-mixin | 274.00 B  | 58.32 B    | 2.8           | 0.2
	ember-data/serializers/json-api               | 251.00 B  | 53.42 B    | 2.5           | 0.2
	ember-data/adapters/json-api                  | 245.00 B  | 52.14 B    | 2.5           | 0.1
	ember-data/serializers/json                   | 243.00 B  | 51.72 B    | 2.4           | 0.1
	ember-data/serializers/rest                   | 243.00 B  | 51.72 B    | 2.4           | 0.1
	ember-data/transform                          | 241.00 B  | 51.29 B    | 2.4           | 0.1
	ember-data/adapters/rest                      | 237.00 B  | 50.44 B    | 2.4           | 0.1
	ember-data/serializer                         | 232.00 B  | 49.38 B    | 2.3           | 0.1
	ember-data/adapter                            | 226.00 B  | 48.10 B    | 2.3           | 0.1
	ember-data/model                              | 222.00 B  | 47.25 B    | 2.2           | 0.1
	ember-data/attr                               | 218.00 B  | 46.40 B    | 2.2           | 0.1
	ember-data/initialize-store-service           | 207.00 B  | 44.06 B    | 2.1           | 0.1
	ember-data/version                            | 162.00 B  | 34.48 B    | 1.6           | 0.1

Package: ember-inflector
┌──────────────┬───────────┐
│   (index)    │  Values   │
├──────────────┼───────────┤
│    bytes     │ '7.90 KB' │
│  compressed  │ '1.68 KB' │
│ % Of Library │   '4.9'   │
└──────────────┴───────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	ember-inflector/lib/system/inflector          | 2.75 KB   | 599.60 B   | 34.8          | 1.7
	ember-inflector/lib/system/inflections        | 1.57 KB   | 342.69 B   | 19.9          | 1.0
	ember-inflector/index                         | 1.12 KB   | 244.35 B   | 14.2          | 0.7
	ember-inflector/lib/ext/string                | 783.00 B  | 166.66 B   | 9.7           | 0.5
	ember-inflector/lib/system                    | 452.00 B  | 96.20 B    | 5.6           | 0.3
	ember-inflector/lib/system/string             | 351.00 B  | 74.71 B    | 4.3           | 0.2
	ember-inflector/lib/helpers/pluralize         | 348.00 B  | 74.07 B    | 4.3           | 0.2
	ember-inflector/lib/utils/make-helper         | 308.00 B  | 65.55 B    | 3.8           | 0.2
	ember-inflector/lib/helpers/singularize       | 271.00 B  | 57.68 B    | 3.4           | 0.2

Package: @ember-data/debug
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '2.68 KB'  │
│  compressed  │ '583.85 B' │
│ % Of Library │   '1.7'    │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/debug/index                       | 2.19 KB   | 477.64 B   | 81.8          | 1.4
	@ember-data/debug/setup                       | 499.00 B  | 106.21 B   | 18.2          | 0.3

Package: @ember/ordered-set
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '1.05 KB'  │
│  compressed  │ '229.45 B' │
│ % Of Library │   '0.7'    │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember/ordered-set/index                      | 1.05 KB   | 229.45 B   | 100.0         | 0.7

Package: @ember-data/unpublished-test-infra
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '186.00 B' │
│  compressed  │ '39.59 B'  │
│ % Of Library │   '0.1'    │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/unpublished-test-infra/version    | 186.00 B  | 39.59 B    | 100.0         | 0.1

@github-actions

This comment has been minimized.

Copy link

github-actions bot commented Nov 26, 2019

Asset Size Report for cc107fc

EmberData has not changed in size

If any packages had changed sizes they would be listed here.

Changeset



Full Asset Analysis

Asset Size Report
=================


Library: EmberData
┌────────────┬─────────────┐
│  (index)   │   Values    │
├────────────┼─────────────┤
│   bytes    │ '160.49 KB' │
│ compressed │ '34.16 KB'  │
│  packages  │     10      │
│  modules   │     48      │
└────────────┴─────────────┘

Package: @ember-data/store
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '71.04 KB' │
│  compressed  │ '15.12 KB' │
│ % Of Library │   '44.3'   │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/store/-private                    | 70.13 KB  | 14.93 KB   | 98.7          | 43.7
	@ember-data/store/index                       | 936.00 B  | 199.23 B   | 1.3           | 0.6

Package: @ember-data/record-data
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '22.97 KB' │
│  compressed  │ '4.89 KB'  │
│ % Of Library │   '14.3'   │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/record-data/-private              | 22.97 KB  | 4.89 KB    | 100.0         | 14.3

Package: @ember-data/serializer
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '19.30 KB' │
│  compressed  │ '4.11 KB'  │
│ % Of Library │   '12.0'   │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/serializer/json                   | 7.10 KB   | 1.51 KB    | 36.8          | 4.4
	@ember-data/serializer/-private               | 5.36 KB   | 1.14 KB    | 27.8          | 3.3
	@ember-data/serializer/json-api               | 3.71 KB   | 807.99 B   | 19.2          | 2.3
	@ember-data/serializer/rest                   | 2.68 KB   | 583.85 B   | 13.9          | 1.7
	@ember-data/serializer/index                  | 243.00 B  | 51.72 B    | 1.2           | 0.1
	@ember-data/serializer/transform              | 215.00 B  | 45.76 B    | 1.1           | 0.1

Package: @ember-data/adapter
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '14.57 KB' │
│  compressed  │ '3.10 KB'  │
│ % Of Library │   '9.1'    │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/adapter/rest                      | 7.65 KB   | 1.63 KB    | 52.5          | 4.8
	@ember-data/adapter/-private                  | 3.50 KB   | 762.86 B   | 24.0          | 2.2
	@ember-data/adapter/error                     | 1.91 KB   | 416.98 B   | 13.1          | 1.2
	@ember-data/adapter/json-api                  | 830.00 B  | 176.66 B   | 5.6           | 0.5
	@ember-data/adapter/index                     | 719.00 B  | 153.04 B   | 4.8           | 0.4

Package: @ember-data/model
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '11.08 KB' │
│  compressed  │ '2.36 KB'  │
│ % Of Library │   '6.9'    │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/model/-private                    | 10.60 KB  | 2.26 KB    | 95.7          | 6.6
	@ember-data/model/index                       | 486.00 B  | 103.44 B   | 4.3           | 0.3

Package: ember-data
┌──────────────┬───────────┐
│   (index)    │  Values   │
├──────────────┼───────────┤
│    bytes     │ '9.72 KB' │
│  compressed  │ '2.07 KB' │
│ % Of Library │   '6.1'   │
└──────────────┴───────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	ember-data/index                              | 2.42 KB   | 527.66 B   | 24.9          | 1.5
	ember-data/-private                           | 1.98 KB   | 431.87 B   | 20.4          | 1.2
	ember-data/adapters/errors                    | 1.19 KB   | 259.04 B   | 12.2          | 0.7
	ember-data/setup-container                    | 503.00 B  | 107.06 B   | 5.1           | 0.3
	ember-data/store                              | 406.00 B  | 86.41 B    | 4.1           | 0.2
	ember-data/relationships                      | 318.00 B  | 67.68 B    | 3.2           | 0.2
	ember-data/serializers/embedded-records-mixin | 274.00 B  | 58.32 B    | 2.8           | 0.2
	ember-data/serializers/json-api               | 251.00 B  | 53.42 B    | 2.5           | 0.2
	ember-data/adapters/json-api                  | 245.00 B  | 52.14 B    | 2.5           | 0.1
	ember-data/serializers/json                   | 243.00 B  | 51.72 B    | 2.4           | 0.1
	ember-data/serializers/rest                   | 243.00 B  | 51.72 B    | 2.4           | 0.1
	ember-data/transform                          | 241.00 B  | 51.29 B    | 2.4           | 0.1
	ember-data/adapters/rest                      | 237.00 B  | 50.44 B    | 2.4           | 0.1
	ember-data/serializer                         | 232.00 B  | 49.38 B    | 2.3           | 0.1
	ember-data/adapter                            | 226.00 B  | 48.10 B    | 2.3           | 0.1
	ember-data/model                              | 222.00 B  | 47.25 B    | 2.2           | 0.1
	ember-data/attr                               | 218.00 B  | 46.40 B    | 2.2           | 0.1
	ember-data/initialize-store-service           | 207.00 B  | 44.06 B    | 2.1           | 0.1
	ember-data/version                            | 162.00 B  | 34.48 B    | 1.6           | 0.1

Package: ember-inflector
┌──────────────┬───────────┐
│   (index)    │  Values   │
├──────────────┼───────────┤
│    bytes     │ '7.90 KB' │
│  compressed  │ '1.68 KB' │
│ % Of Library │   '4.9'   │
└──────────────┴───────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	ember-inflector/lib/system/inflector          | 2.75 KB   | 599.60 B   | 34.8          | 1.7
	ember-inflector/lib/system/inflections        | 1.57 KB   | 342.69 B   | 19.9          | 1.0
	ember-inflector/index                         | 1.12 KB   | 244.35 B   | 14.2          | 0.7
	ember-inflector/lib/ext/string                | 783.00 B  | 166.66 B   | 9.7           | 0.5
	ember-inflector/lib/system                    | 452.00 B  | 96.20 B    | 5.6           | 0.3
	ember-inflector/lib/system/string             | 351.00 B  | 74.71 B    | 4.3           | 0.2
	ember-inflector/lib/helpers/pluralize         | 348.00 B  | 74.07 B    | 4.3           | 0.2
	ember-inflector/lib/utils/make-helper         | 308.00 B  | 65.55 B    | 3.8           | 0.2
	ember-inflector/lib/helpers/singularize       | 271.00 B  | 57.68 B    | 3.4           | 0.2

Package: @ember-data/debug
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '2.68 KB'  │
│  compressed  │ '583.85 B' │
│ % Of Library │   '1.7'    │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/debug/index                       | 2.19 KB   | 477.64 B   | 81.8          | 1.4
	@ember-data/debug/setup                       | 499.00 B  | 106.21 B   | 18.2          | 0.3

Package: @ember/ordered-set
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '1.05 KB'  │
│  compressed  │ '229.45 B' │
│ % Of Library │   '0.7'    │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember/ordered-set/index                      | 1.05 KB   | 229.45 B   | 100.0         | 0.7

Package: @ember-data/unpublished-test-infra
┌──────────────┬────────────┐
│   (index)    │   Values   │
├──────────────┼────────────┤
│    bytes     │ '186.00 B' │
│  compressed  │ '39.59 B'  │
│ % Of Library │   '0.1'    │
└──────────────┴────────────┘
	Module                                        | Bytes     | Compressed | % of Package  | % Of Library
	-----------------------------------------------------------------------------------------------------
	@ember-data/unpublished-test-infra/version    | 186.00 B  | 39.59 B    | 100.0         | 0.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
🌲 Project Trim 🌲
  
In Development
3 participants
You can’t perform that action at this time.