https://github.com/eddie0329/next-server-logger
next.js helper tool that enable passing server logs, which are defined inside getServerSideProps, getStaticProps, or getInitialProps, to browser.
https://github.com/eddie0329/next-server-logger
getinitialprops getserversideprops getstaticprops library logger nextjs
Last synced: 4 days ago
JSON representation
next.js helper tool that enable passing server logs, which are defined inside getServerSideProps, getStaticProps, or getInitialProps, to browser.
- Host: GitHub
- URL: https://github.com/eddie0329/next-server-logger
- Owner: eddie0329
- Created: 2023-01-26T13:54:14.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-30T11:06:08.000Z (almost 3 years ago)
- Last Synced: 2025-09-17T13:10:19.215Z (7 months ago)
- Topics: getinitialprops, getserversideprops, getstaticprops, library, logger, nextjs
- Language: TypeScript
- Homepage:
- Size: 1.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 🤔 What is next-server-logger?
Have you ever had experience debugging code in `getServerSideProps, getStaticProps, or getInitailProps?`
It's hard to debug when application is deployed and need some extra steps to see actual logged.
Now use NextServerLogger and see logs in browser. 🎉
NextServerLogger is `next.js helper tool` that enable passing server logs, which are defined inside getServerSideProps, getStaticProps, or getInitialProps, to browser.
## 🛠 Installation
```shell
yarn add next-server-logger
npm install next-server-logger
```
```javascript
// _app.js
import { NextServerLoggerProvider } from 'next-server-logger'
export default function App({ Component, pageProps }) {
return (
<>
>
);
}
```
## 🌈 Usage
### 1. App.getInitialProps
```javascript
import { getServerLogger } from 'next-server-logger'
App.getInitialProps = async ({ Component, ctx }) => {
let pageProps = {};
if (Component.getInitialProps) {
pageProps = await Component.getInitialProps(ctx);
}
const logger = getServerLogger();
logger.log('hello world'); // logging
return {
pageProps: {
...pageProps,
...logger.getAppLoggerProps() // ⭐️ need to pass logger props
},
};
};
```
### 2. getServerSideProps
```javascript
import { getServerLogger } from 'next-server-logger'
export const getServerSideProps = () => {
const logger = getServerLogger();
logger.log('hello world server side props'); // logging
return {
props: {
...logger.getLoggerProps(), // ⭐️ need to pass logger props
},
};
};
```
### 3. getStaticProps
```javascript
import { getServerLogger } from 'next-server-logger'
export const getStaticProps = () => {
const logger = getServerLogger();
logger.log('hello world static props'); // logging
return {
props: {
...logger.getLoggerProps(), // ⭐️ need to pass logger props
},
};
};
```
## 🚧 Interface
### NextServerLoggerProvider
```typescript
type NextServerLoggerProvider = React.FC<{ pageProps: any, enable?: boolean | true }>
```
NextServerLoggerProvider has two props, pageProps and enable.
`pageProps` is next page props.
`enable` can handle logging enabled or not.
### logger.log
```typescript
type logger.log = (...params: any[]) => void
```
Logger.log -> pass any params you want to log just like console.log