graphile-search-plugin 0.1.14 โ†’ 0.1.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +17 -4
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -16,15 +16,21 @@
16
16
  </a>
17
17
  </p>
18
18
 
19
- This [PostGraphile](http://postgraphile.org/) schema plugin was built to enable ordering via `ts_rank` of full-text search on all `tsvector` fields, providing auto-generated queries within PostGraphile.
19
+ **`graphile-search-plugin`** enables `ts_rank` ordering and auto-generated full-text search helpers for all `tsvector` fields in PostGraphile schemas.
20
20
 
21
- ## Install
21
+ ## ๐Ÿš€ Installation
22
22
 
23
23
  ```sh
24
24
  npm install graphile-search-plugin
25
25
  ```
26
26
 
27
- ## Usage
27
+ ## โœจ Features
28
+
29
+ - Adds full-text search helpers for `tsvector` columns
30
+ - Enables ordering via `ts_rank` on generated search fields
31
+ - Works with PostGraphile append plugin pipeline
32
+
33
+ ## ๐Ÿ“ฆ Usage
28
34
 
29
35
  1. Append the new plugins!
30
36
  2. Query `search<YourTsvectorColumn>` in the `conditions` field
@@ -43,10 +49,17 @@ app.use(
43
49
  );
44
50
  ```
45
51
 
46
- ## Examples
52
+ ## ๐Ÿงช Examples
47
53
 
48
54
  Look in the tests ;)
49
55
 
56
+ ## ๐Ÿงช Testing
57
+
58
+ ```sh
59
+ # requires a local Postgres available (defaults to postgres/password@localhost:5432)
60
+ pnpm --filter graphile-search-plugin test
61
+ ```
62
+
50
63
  ---
51
64
 
52
65
  ## Education and Tutorials
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "graphile-search-plugin",
3
- "version": "0.1.14",
3
+ "version": "0.1.15",
4
4
  "description": "generate search conditions for your tsvector columns",
5
5
  "author": "Dan Lynch <pyramation@gmail.com>",
6
6
  "homepage": "https://github.com/launchql/launchql",
@@ -38,16 +38,16 @@
38
38
  "url": "https://github.com/launchql/launchql/issues"
39
39
  },
40
40
  "devDependencies": {
41
- "graphile-plugin-connection-filter": "^2.3.2",
42
- "graphile-plugin-fulltext-filter": "^2.0.3",
43
- "graphile-simple-inflector": "^0.1.9",
44
- "graphile-test": "^2.8.10",
41
+ "graphile-plugin-connection-filter": "^2.3.3",
42
+ "graphile-plugin-fulltext-filter": "^2.0.4",
43
+ "graphile-simple-inflector": "^0.1.10",
44
+ "graphile-test": "^2.8.11",
45
45
  "makage": "^0.1.8",
46
- "pgsql-test": "^2.14.13"
46
+ "pgsql-test": "^2.14.14"
47
47
  },
48
48
  "dependencies": {
49
49
  "graphile-build": "^4.14.1",
50
50
  "graphql-tag": "2.12.6"
51
51
  },
52
- "gitHead": "4e1ff9771c2b07808a9830281abc24d12c689187"
52
+ "gitHead": "00c90828cab8d3e306ebb2bc6053aab4aa9ae807"
53
53
  }