Skip to content

Fix small inconsistencies of README examples #452

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.

Sign up for GitHub

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

Open
oscar0urselli wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix small inconsistencies of README examples #452

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6277a1d
docs(readme): Fix small inconsistencies of README examples.
oscar0urselli Jul 2, 2026
0ec7d12
Merge pull request #1 from oscar0urselli/improve-readme
oscar0urselli Jul 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 24 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,10 @@ import * as permify from "@permify/permify-node";

const client = permify.grpc.newClient({
endpoint: "localhost:3478", // Replace with your Permify server URL
cert: undefined, // Optional: SSL certificate
cert: null, // Optional: SSL certificate
insecure: true, // Set to false in production
timeout: 5000, // Request timeout in milliseconds
pk: null, // Optional: The client private key
certChain: null // Optional: The client certificate key chain
});
```

Expand All @@ -71,8 +72,10 @@ import * as permify from "@permify/permify-node";

const client = permify.grpc.newClient({
endpoint: "localhost:3478",
cert: undefined,
cert: null,
insecure: true,
pk: null,
certChain: null
});

client.tenancy
Expand All @@ -95,8 +98,10 @@ import * as permify from "@permify/permify-node";

const client = permify.grpc.newClient({
endpoint: "localhost:3478",
cert: undefined,
cert: null,
insecure: true,
pk: null,
certChain: null
});

let schema = `
Expand Down Expand Up @@ -132,11 +137,13 @@ import * as permify from "@permify/permify-node";

const client = permify.grpc.newClient({
endpoint: "localhost:3478",
cert: undefined,
cert: null,
insecure: true,
pk: null,
certChain: null
});

client.relationship
client.data
.write({
tenantId: "t1",
metadata: {
Expand Down Expand Up @@ -170,8 +177,10 @@ import * as permify from "@permify/permify-node";

const client = permify.grpc.newClient({
endpoint: "localhost:3478",
cert: undefined,
cert: null,
insecure: true,
pk: null,
certChain: null
});

client.permission
Expand Down Expand Up @@ -213,8 +222,10 @@ import * as permify from "@permify/permify-node";
function main() {
const client = permify.grpc.newClient({
endpoint: "localhost:3478",
cert: undefined,
cert: null,
insecure: true,
pk: null,
certChain: null
});

let res = client.permission.lookupEntityStream({
Expand Down Expand Up @@ -254,8 +265,10 @@ import * as permify from "@permify/permify-node";
const client = new permify.grpc.newClient(
{
endpoint: "localhost:3478",
cert: undefined,
cert: null,
insecure: true,
pk: null,
certChain: null
},
permify.grpc.newAccessTokenInterceptor("YOUR_TOKEN")
);
Expand All @@ -274,6 +287,8 @@ const client = new permify.grpc.newClient(
endpoint: "localhost:3478",
cert: cert,
insecure: true,
pk: null,
certChain: null
},
permify.grpc.newAccessTokenInterceptor("YOUR_TOKEN")
);
Expand Down