Skip to content

Commit 9a4292b

Browse files
authored
feat: rolling changes (#163)
## Docs * docs: fix/add missing updates * docs: small updates ## Chore * chore: updated issue templates * chore(deps-dev): updated typescript version * chore(deps-dev): updated dependencies * @typescript-eslint/eslint-plugin * @typescript-eslint/parser * eslint * lint-staged * rollup * typescript * chore: incremented package version ## Fix * fix(api-calls)!: updated multi word model endpoint guessing * fix(global-config): fixed `set` typing * Overloads also greatly simplified the signature ## CI * ci: force staging of files
1 parent da3597f commit 9a4292b

File tree

17 files changed

+862
-1145
lines changed

17 files changed

+862
-1145
lines changed

.github/ISSUE_TEMPLATE/config.yml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
blank_issues_enabled: false
3+
contact_links:
4+
-
5+
about: "Please ask and answer usage questions in the discussion section."
6+
name: Question
7+
url: "https://github.com/upfrontjs/framework/discussions/new?category=q-a"

.github/ISSUE_TEMPLATE/feature_request.md

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ assignees: ''
77

88
---
99

10+
<!---
11+
If your suggestion involves substantial changes/breaking changes/otherwise a lot of work, consider opening a discussion first.
12+
-->
13+
1014
**Search terms**
1115
The terms you searched for in the issues before opening a new issue.
1216

.github/ISSUE_TEMPLATE/question.md

-23
This file was deleted.

.github/workflows/deploy-api-docs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,6 @@ jobs:
2121
- name: Update gh-pages branch
2222
run: |
2323
git config --global user.name "${{ github.actor }}"
24-
git add api-docs
24+
git add -f api-docs
2525
git commit -m "Updates from ${{ github.ref }}"
2626
git push -u origin gh-pages

docs/calliope/attributes.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Models have been given powerful tools to manage data without involved logic and
44

55
- [Casting](#casting)
66
- [Guarding](#guarding)
7-
- [Mutators/Accessors](#mutatorsaccessors)
7+
- [Mutators/Accessors](#mutators-accessors)
88
- [Attribute management](#attribute-management)
99
- [Tracking changes](#tracking-changes)
1010

@@ -327,7 +327,7 @@ user.fullName; // 'Dr. John Doe'
327327
Models can be constructed with the `new` keyword. This will mass assign attributes to the model while respecting the [guarding](#guarding) settings.
328328

329329
::: warning
330-
When constructing an instance and only passing in another instance of the model:
330+
When constructing an instance and passing in another instance of the model:
331331
```js
332332
import User from '@Models/User';
333333
import Shift from '@Models/Shift';
@@ -524,15 +524,15 @@ const user = new User({ firstName: 'John', lastName: 'Doe', title: 'Dr.' });
524524
user.except(['fistName', 'title']); // { lastName: 'Doe' }
525525
```
526526

527-
#### toJson
527+
#### toJSON
528528

529-
The `toJson` method returns the json string representation of the model's attributes and relations.
529+
The `toJSON` method returns the json representation of the model's attributes and relations.
530530

531531
```js
532532
import User from '@Models/User';
533533

534534
const user = new User({ name: 'John Doe' });
535-
user.addRelation('shifts', new Shift({ shiftAttr: 1 })).toJson(); // {"name":"John Doe","shifts":[{"shiftAttr":1}]}
535+
user.addRelation('shifts', new Shift({ shiftAttr: 1 })).toJSON(); // {"name":"John Doe","shifts":[{"shiftAttr":1}]}
536536
```
537537

538538
## Tracking changes

docs/calliope/timestamps.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The `freshTimestamps` method sends `GET` request [selecting](./query-building.md
5252

5353
### Properties
5454

55-
##### deletedAt
55+
#### deletedAt
5656

5757
The `deletedAt` is a static property on the model. The default value is `'deletedAt'`. You may over ride this if the expected timestamp attribute is named differently.
5858
The letter casing is no concern here as [getDeletedAtColumn](#getdeletedatcolumn) will update it to the correct casing.

docs/getting-started/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,5 @@ While using this package increases ease of access and cuts down development time
2121

2222
---
2323

24-
As always you're encouraged to explore the [source](https://github.com/upfrontjs/framework) yourself or look at the api reference to gain insight on how the package works, and the tests to see how it's used.
24+
As always you're encouraged to explore the [source](https://github.com/upfrontjs/framework) yourself or look at the api reference to gain insight on how the package works, and the [tests](https://github.com/upfrontjs/framework/tree/main/tests) to see how it's used.
2525

0 commit comments

Comments
 (0)